@react-navigation/core 8.0.0-alpha.37 → 8.0.0-alpha.39

package/src/NavigationIndependentTree.tsx

@@ -5,7 +5,6 @@ import { NavigationContainerRefContext } from './NavigationContainerRefContext';
 import { NavigationFocusedRouteStateContext } from './NavigationFocusedRouteStateContext';
 import { NavigationHelpersContext } from './NavigationHelpersContext';
 import { NavigationIndependentTreeContext } from './NavigationIndependentTreeContext';
-import { NavigationMetaContext } from './NavigationMetaContext';
 import {
   IsScreenContext,
   NamedRouteContextListContext,
@@ -40,41 +39,39 @@ export function NavigationIndependentTree({
         <NavigationRootContext.Provider value={undefined}>
           <NavigationBuilderContext.Provider value={undefined}>
             <StaticTreeContext.Provider value={undefined}>
-              <NavigationMetaContext.Provider value={undefined}>
-                <NavigationHelpersContext.Provider value={undefined}>
-                  <NavigationStateListenerContext.Provider value={undefined}>
-                    <FocusedRouteKeyContext.Provider value={undefined}>
-                      <PreventRemoveContext.Provider value={undefined}>
-                        <NamedNavigationStateListenerListContext.Provider
+              <NavigationHelpersContext.Provider value={undefined}>
+                <NavigationStateListenerContext.Provider value={undefined}>
+                  <FocusedRouteKeyContext.Provider value={undefined}>
+                    <PreventRemoveContext.Provider value={undefined}>
+                      <NamedNavigationStateListenerListContext.Provider
+                        value={undefined}
+                      >
+                        <NamedRouteContextListContext.Provider
                           value={undefined}
                         >
-                          <NamedRouteContextListContext.Provider
-                            value={undefined}
-                          >
-                            <NavigationRouteContext.Provider value={undefined}>
-                              <NavigationContext.Provider value={undefined}>
-                                <IsFocusedContext.Provider value={undefined}>
-                                  <IsFocusedGetterContext.Provider
-                                    value={undefined}
-                                  >
-                                    <IsScreenContext.Provider value={false}>
-                                      <NavigationFocusedRouteStateContext.Provider
-                                        value={undefined}
-                                      >
-                                        {children}
-                                      </NavigationFocusedRouteStateContext.Provider>
-                                    </IsScreenContext.Provider>
-                                  </IsFocusedGetterContext.Provider>
-                                </IsFocusedContext.Provider>
-                              </NavigationContext.Provider>
-                            </NavigationRouteContext.Provider>
-                          </NamedRouteContextListContext.Provider>
-                        </NamedNavigationStateListenerListContext.Provider>
-                      </PreventRemoveContext.Provider>
-                    </FocusedRouteKeyContext.Provider>
-                  </NavigationStateListenerContext.Provider>
-                </NavigationHelpersContext.Provider>
-              </NavigationMetaContext.Provider>
+                          <NavigationRouteContext.Provider value={undefined}>
+                            <NavigationContext.Provider value={undefined}>
+                              <IsFocusedContext.Provider value={undefined}>
+                                <IsFocusedGetterContext.Provider
+                                  value={undefined}
+                                >
+                                  <IsScreenContext.Provider value={false}>
+                                    <NavigationFocusedRouteStateContext.Provider
+                                      value={undefined}
+                                    >
+                                      {children}
+                                    </NavigationFocusedRouteStateContext.Provider>
+                                  </IsScreenContext.Provider>
+                                </IsFocusedGetterContext.Provider>
+                              </IsFocusedContext.Provider>
+                            </NavigationContext.Provider>
+                          </NavigationRouteContext.Provider>
+                        </NamedRouteContextListContext.Provider>
+                      </NamedNavigationStateListenerListContext.Provider>
+                    </PreventRemoveContext.Provider>
+                  </FocusedRouteKeyContext.Provider>
+                </NavigationStateListenerContext.Provider>
+              </NavigationHelpersContext.Provider>
             </StaticTreeContext.Provider>
           </NavigationBuilderContext.Provider>
         </NavigationRootContext.Provider>

package/src/StaticNavigation.tsx

@@ -522,7 +522,7 @@ type StaticConfigCommon<Bag extends NavigatorTypeBagBase> = Omit<
   'screens' | 'children'
 >;
 
-export type StaticConfigBase<
+type StaticConfigBase<
   Bag extends NavigatorTypeBagBase,
   Screens = StaticConfigScreensForBag<Bag>,
   Groups = StaticConfigGroupsForBag<Bag>,

package/src/index.tsx

@@ -17,7 +17,6 @@ export {
 } from './NavigationFocusedRouteStateContext';
 export { NavigationHelpersContext } from './NavigationHelpersContext';
 export { NavigationIndependentTree } from './NavigationIndependentTree';
-export { NavigationMetaContext } from './NavigationMetaContext';
 export {
   IsScreenContext,
   NavigationContext,

package/src/types.tsx

@@ -81,7 +81,7 @@ export type DefaultNavigatorOptions<
   layout?:
     | ((props: {
         state: State;
-        navigation: NavigationHelpers<ParamList>;
+        navigation: NavigationHelpers<ParamList, State>;
         descriptors: Record<
           string,
           Descriptor<
@@ -259,7 +259,7 @@ export type EventEmitter<in out EventMap extends EventMapBase> = {
   emit<EventName extends KeyOf<EventMap>>(
     options: {
       type: EventName;
-      target?: string;
+      target?: string | undefined;
     } & (EventMap[EventName]['canPreventDefault'] extends true
       ? { canPreventDefault: true }
       : {}) &
@@ -470,8 +470,9 @@ type NavigationHelpersRoute<
 
 export type NavigationHelpers<
   ParamList extends ParamListBase,
+  State extends NavigationState = NavigationState<ParamList>,
   EventMap extends EventMapBase = {},
-> = NavigationHelpersCommon<ParamList> &
+> = NavigationHelpersCommon<ParamList, State> &
   EventEmitter<EventMap> &
   NavigationHelpersRoute<ParamList, keyof ParamList> &
   PrivateValueStore<[ParamList, unknown, unknown, unknown]>;

package/src/useDescriptors.tsx

@@ -76,10 +76,11 @@ type Options<
     ScreenConfigWithParent<State, ScreenOptions, EventMap>
   >;
   state: State;
-  navigation: NavigationHelpers<ParamListBase>;
+  navigation: NavigationHelpers<ParamListBase, State>;
   screenOptions: ScreenOptionsOrCallback<ScreenOptions> | undefined;
   screenLayout: ScreenLayout<ScreenOptions> | undefined;
   onAction: (action: NavigationAction) => boolean;
+  canGoBack: (source?: string) => boolean;
   getState: () => State;
   setState: (state: State) => void;
   subscribe: (callback: () => void) => () => void;
@@ -134,6 +135,7 @@ export function useDescriptors<
   screenOptions,
   screenLayout,
   onAction,
+  canGoBack,
   getState,
   setState,
   subscribe,
@@ -162,6 +164,7 @@ export function useDescriptors<
     () => ({
       navigation,
       onAction,
+      canGoBack,
       addListener,
       addKeyedListener,
       onRouteFocus,
@@ -176,6 +179,7 @@ export function useDescriptors<
     [
       navigation,
       onAction,
+      canGoBack,
       addListener,
       addKeyedListener,
       onRouteFocus,
@@ -196,6 +200,7 @@ export function useDescriptors<
     ActionHelpers
   >({
     routes: state.routes,
+    canGoBack,
     getState,
     navigation,
     setOptions,

package/src/useEventEmitter.tsx

@@ -59,7 +59,7 @@ export function useEventEmitter<T extends Record<string, any>>(
     }: {
       type: string;
       data?: any;
-      target?: string;
+      target?: string | undefined;
       canPreventDefault?: boolean;
     }) => {
       const items = listeners.current[type];

package/src/useNavigationBuilder.tsx

@@ -21,7 +21,6 @@ import { Group } from './Group';
 import { isArrayEqual } from './isArrayEqual';
 import { useNavigationBuilderContext } from './NavigationBuilderContext';
 import { NavigationHelpersContext } from './NavigationHelpersContext';
-import { NavigationMetaContext } from './NavigationMetaContext';
 import { IsScreenContext, NavigationRouteContext } from './NavigationProvider';
 import { NavigationStateContext } from './NavigationStateContext';
 import { PreventRemoveProvider } from './PreventRemoveProvider';
@@ -459,7 +458,11 @@ export function useNavigationBuilder<
     getIsInitial,
   } = React.use(NavigationStateContext);
 
-  const { onEmitEvent, getIsStateEmitted } = useNavigationBuilderContext();
+  const {
+    onEmitEvent,
+    getIsStateEmitted,
+    canGoBack: canGoBackParent,
+  } = useNavigationBuilderContext();
 
   const mountStateRef = React.useRef<'initial' | 'mounted' | 'unmounted'>(
     'initial'
@@ -1003,6 +1006,31 @@ export function useNavigationBuilder<
     onUnhandledActionParent?.(action);
   });
 
+  const canGoBack = useLatestCallback((source?: string) => {
+    const state = getState();
+
+    return (
+      router.getStateForAction(
+        state,
+        { ...CommonActions.goBack(), source },
+        {
+          routeNames: state.routeNames,
+          routeParamList: {},
+          routeGetIdList: {},
+        }
+      ) !== null ||
+      canGoBackParent?.(
+        // If the `source` belonged to the current navigator,
+        // rewrite the `source` to the parent screen's key when checking
+        // This mirrors the way actions bubble up to the parent
+        source !== undefined && state.routes.some((r) => r.key === source)
+          ? route?.key
+          : source
+      ) ||
+      false
+    );
+  });
+
   const navigation = useNavigationHelpers<
     State,
     ActionHelpers,
@@ -1011,6 +1039,7 @@ export function useNavigationBuilder<
   >({
     onAction,
     onUnhandledAction,
+    canGoBack,
     getState,
     emitter,
     router,
@@ -1040,6 +1069,7 @@ export function useNavigationBuilder<
     screenOptions,
     screenLayout,
     onAction,
+    canGoBack,
     getState,
     setState,
     subscribe,
@@ -1069,24 +1099,22 @@ export function useNavigationBuilder<
         : children;
 
     return (
-      <NavigationMetaContext.Provider value={undefined}>
-        <NavigationHelpersContext.Provider value={navigation}>
-          <NavigationStateListenerProvider
-            isSynced={!shouldUpdate}
-            state={state}
-            getState={getState}
-            subscribe={subscribe}
-          >
-            <FocusedRouteKeyContext.Provider value={focusedRoute.key}>
-              <PreventRemoveProvider>
-                <IsScreenContext.Provider value={false}>
-                  {element}
-                </IsScreenContext.Provider>
-              </PreventRemoveProvider>
-            </FocusedRouteKeyContext.Provider>
-          </NavigationStateListenerProvider>
-        </NavigationHelpersContext.Provider>
-      </NavigationMetaContext.Provider>
+      <NavigationHelpersContext.Provider value={navigation}>
+        <NavigationStateListenerProvider
+          isSynced={!shouldUpdate}
+          state={state}
+          getState={getState}
+          subscribe={subscribe}
+        >
+          <FocusedRouteKeyContext.Provider value={focusedRoute.key}>
+            <PreventRemoveProvider>
+              <IsScreenContext.Provider value={false}>
+                {element}
+              </IsScreenContext.Provider>
+            </PreventRemoveProvider>
+          </FocusedRouteKeyContext.Provider>
+        </NavigationStateListenerProvider>
+      </NavigationHelpersContext.Provider>
     );
   };
 

package/src/useNavigationCache.tsx

@@ -19,8 +19,9 @@ type Options<
 > = {
   routes: State['routes'];
   getState: () => State;
-  navigation: NavigationHelpers<ParamListBase> &
+  navigation: NavigationHelpers<ParamListBase, State> &
     Partial<NavigationProp<ParamListBase, string, any, any, any>>;
+  canGoBack: (source?: string) => boolean;
   setOptions: (
     cb: (
       options: Record<string, Partial<ScreenOptions> | undefined>
@@ -68,6 +69,7 @@ export function useNavigationCache<
   routes,
   getState,
   navigation,
+  canGoBack,
   setOptions,
   router,
   emitter,
@@ -89,6 +91,7 @@ export function useNavigationCache<
       getState,
       parentNavigation,
       navigation,
+      canGoBack,
       setOptions,
       router,
       emitter,
@@ -155,6 +158,7 @@ export function useNavigationCache<
           // FIXME: too much work to fix the types for now
           ...(emitter.create(route.key) as any),
           dispatch,
+          canGoBack: () => canGoBack(route.key),
           getParent: (routeName) => {
             if (routeName === route.name) {
               // If the passed route name is the same as the current route's name,
@@ -203,6 +207,7 @@ export function useNavigationCache<
     routes,
     getState,
     navigation,
+    canGoBack,
     router,
     withStackTrace,
     emitter,

package/src/useNavigationHelpers.tsx

@@ -19,6 +19,7 @@ PrivateValueStore;
 type Options<State extends NavigationState, Action extends NavigationAction> = {
   onAction: (action: NavigationAction) => boolean;
   onUnhandledAction: (action: NavigationAction) => void;
+  canGoBack: (source?: string) => boolean;
   getState: () => State;
   emitter: NavigationEventEmitter<any>;
   router: Router<State, Action>;
@@ -36,11 +37,13 @@ export function useNavigationHelpers<
 >({
   onAction,
   onUnhandledAction,
+  canGoBack,
   getState,
   emitter,
   router,
 }: Options<State, Action>) {
   const parentNavigationHelpers = React.use(NavigationContext);
+
   const { withStackTrace } = useNavigationBuilderContext();
 
   return React.useMemo(() => {
@@ -82,27 +85,16 @@ export function useNavigationHelpers<
       isFocused: parentNavigationHelpers
         ? parentNavigationHelpers.isFocused
         : () => true,
-      canGoBack: () => {
-        const state = getState();
-
-        return (
-          router.getStateForAction(state, CommonActions.goBack() as Action, {
-            routeNames: state.routeNames,
-            routeParamList: {},
-            routeGetIdList: {},
-          }) !== null ||
-          parentNavigationHelpers?.canGoBack() ||
-          false
-        );
-      },
+      canGoBack: () => canGoBack(),
       getState,
-    } as NavigationHelpers<ParamListBase, EventMap> & ActionHelpers;
+    } as NavigationHelpers<ParamListBase, State, EventMap> & ActionHelpers;
 
     return navigationHelpers;
   }, [
-    router,
+    router.actionCreators,
     parentNavigationHelpers,
     emitter.emit,
+    canGoBack,
     getState,
     onAction,
     onUnhandledAction,

package/src/useOnAction.tsx

@@ -166,19 +166,44 @@ export function useOnAction<State extends NavigationState>({
         }
       }
 
+      const isSourceInCurrentNavigator =
+        action.source !== undefined &&
+        state.routes.some((r) => r.key === action.source);
+
       if (onActionParent !== undefined) {
         // Bubble action to the parent if the current navigator didn't handle it
-        if (onActionParent(action, visitedNavigators)) {
+        const parentAction =
+          isSourceInCurrentNavigator && key !== undefined
+            ? {
+                ...action,
+                // If the `source` belonged to the current navigator,
+                // rewrite the `source` to the parent screen's key when bubbling
+                // This will let parent handle it relative to the child that dispatched the action
+                source: key,
+              }
+            : action;
+
+        if (onActionParent(parentAction, visitedNavigators)) {
           return true;
         }
       }
 
       if (typeof action.target === 'string') {
         // If the action wasn't handled by current navigator or a parent navigator, let children handle it
+        const childAction = isSourceInCurrentNavigator
+          ? {
+              ...action,
+              // If the `source` belonged to the current navigator,
+              // remove it when targeting a child navigator
+              // So child navigators can handle it based on the focused screen
+              source: undefined,
+            }
+          : action;
+
         for (let i = actionListeners.length - 1; i >= 0; i--) {
           const listener = actionListeners[i];
 
-          if (listener?.(action, visitedNavigators)) {
+          if (listener?.(childAction, visitedNavigators)) {
             return true;
           }
         }

package/src/utilities.tsx

@@ -151,7 +151,7 @@ export type QueryParamInput = string | string[] | null | undefined;
  * Supports repeated params with `+` and `*` suffixes as strings.
  * Params must start with `:` at the beginning of a segment (after `/`).
  */
-export type ExtractParamStrings<Path extends string> =
+type ExtractParamStrings<Path extends string> =
   Path extends `${infer Segment}/${infer Rest}`
     ? ExtractSegmentParam<Segment> & ExtractParamStrings<Rest>
     : ExtractSegmentParam<Path>;
@@ -159,7 +159,7 @@ export type ExtractParamStrings<Path extends string> =
 /**
  * Get the type of params based on the `parse` config and the path pattern.
  */
-export type ExtractParamsType<Params, Parse> = {
+type ExtractParamsType<Params, Parse> = {
   /**
    * Base param types from path pattern
    * Refine the type based on standard schema, then parse function

package/lib/module/NavigationMetaContext.js

@@ -1,15 +0,0 @@
-"use strict";
-
-import * as React from 'react';
-
-/**
- * Context with additional metadata to pass to child navigator in a screen.
- * For example, child native stack to know it's inside native tabs.
- * So it doesn't implement features such as `popToTop` that are handled by native tabs.
- *
- * Consumers should not make any assumptions about the shape of the object.
- * It can be different depending on the navigator and may change without notice.
- * This is not intended to be used by application code.
- */
-export const NavigationMetaContext = /*#__PURE__*/React.createContext(undefined);
-//# sourceMappingURL=NavigationMetaContext.js.map

package/lib/module/NavigationMetaContext.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["React","NavigationMetaContext","createContext","undefined"],"sourceRoot":"../../src","sources":["NavigationMetaContext.tsx"],"mappings":";;AAAA,OAAO,KAAKA,KAAK,MAAM,OAAO;;AAE9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,qBAAqB,gBAAGD,KAAK,CAACE,aAAa,CACtDC,SACF,CAAC","ignoreList":[]}

package/lib/typescript/src/NavigationMetaContext.d.ts

@@ -1,12 +0,0 @@
-import * as React from 'react';
-/**
- * Context with additional metadata to pass to child navigator in a screen.
- * For example, child native stack to know it's inside native tabs.
- * So it doesn't implement features such as `popToTop` that are handled by native tabs.
- *
- * Consumers should not make any assumptions about the shape of the object.
- * It can be different depending on the navigator and may change without notice.
- * This is not intended to be used by application code.
- */
-export declare const NavigationMetaContext: React.Context<object | undefined>;
-//# sourceMappingURL=NavigationMetaContext.d.ts.map

package/lib/typescript/src/NavigationMetaContext.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NavigationMetaContext.d.ts","sourceRoot":"","sources":["../../../src/NavigationMetaContext.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,mCAEjC,CAAC"}

package/src/NavigationMetaContext.tsx

@@ -1,14 +0,0 @@
-import * as React from 'react';
-
-/**
- * Context with additional metadata to pass to child navigator in a screen.
- * For example, child native stack to know it's inside native tabs.
- * So it doesn't implement features such as `popToTop` that are handled by native tabs.
- *
- * Consumers should not make any assumptions about the shape of the object.
- * It can be different depending on the navigator and may change without notice.
- * This is not intended to be used by application code.
- */
-export const NavigationMetaContext = React.createContext<object | undefined>(
-  undefined
-);