@react-navigation/core 7.0.0-alpha.0 → 7.0.0-alpha.2

package/src/useOnGetState.tsx

@@ -1,21 +1,19 @@
 import type { NavigationState } from '@react-navigation/routers';
 import * as React from 'react';
 
-import isArrayEqual from './isArrayEqual';
-import NavigationBuilderContext, {
+import { isArrayEqual } from './isArrayEqual';
+import {
   GetStateListener,
+  NavigationBuilderContext,
 } from './NavigationBuilderContext';
-import NavigationRouteContext from './NavigationRouteContext';
+import { NavigationRouteContext } from './NavigationRouteContext';
 
 type Options = {
   getState: () => NavigationState;
   getStateListeners: Record<string, GetStateListener | undefined>;
 };
 
-export default function useOnGetState({
-  getState,
-  getStateListeners,
-}: Options) {
+export function useOnGetState({ getState, getStateListeners }: Options) {
   const { addKeyedListener } = React.useContext(NavigationBuilderContext);
   const route = React.useContext(NavigationRouteContext);
   const key = route ? route.key : 'root';

package/src/useOnPreventRemove.tsx

@@ -4,10 +4,11 @@ import type {
 } from '@react-navigation/routers';
 import * as React from 'react';
 
-import NavigationBuilderContext, {
+import {
   ChildBeforeRemoveListener,
+  NavigationBuilderContext,
 } from './NavigationBuilderContext';
-import NavigationRouteContext from './NavigationRouteContext';
+import { NavigationRouteContext } from './NavigationRouteContext';
 import type { EventMapCore } from './types';
 import type { NavigationEventEmitter } from './useEventEmitter';
 
@@ -72,7 +73,7 @@ export const shouldPreventRemove = (
   return false;
 };
 
-export default function useOnPreventRemove({
+export function useOnPreventRemove({
   getState,
   emitter,
   beforeRemoveListeners,

package/src/useOnRouteFocus.tsx

@@ -5,7 +5,7 @@ import type {
 } from '@react-navigation/routers';
 import * as React from 'react';
 
-import NavigationBuilderContext from './NavigationBuilderContext';
+import { NavigationBuilderContext } from './NavigationBuilderContext';
 
 type Options<Action extends NavigationAction> = {
   router: Router<NavigationState, Action>;
@@ -19,7 +19,7 @@ type Options<Action extends NavigationAction> = {
  * Focus action needs to be treated specially, coz when a nested route is focused,
  * the parent navigators also needs to be focused.
  */
-export default function useOnRouteFocus<Action extends NavigationAction>({
+export function useOnRouteFocus<Action extends NavigationAction>({
   router,
   getState,
   key: sourceRouteKey,

package/src/useOptionsGetters.tsx

@@ -1,8 +1,8 @@
 import type { ParamListBase } from '@react-navigation/routers';
 import * as React from 'react';
 
-import NavigationBuilderContext from './NavigationBuilderContext';
-import NavigationStateContext from './NavigationStateContext';
+import { NavigationBuilderContext } from './NavigationBuilderContext';
+import { NavigationStateContext } from './NavigationStateContext';
 import type { NavigationProp } from './types';
 
 type Options = {
@@ -11,11 +11,7 @@ type Options = {
   options?: object | undefined;
 };
 
-export default function useOptionsGetters({
-  key,
-  options,
-  navigation,
-}: Options) {
+export function useOptionsGetters({ key, options, navigation }: Options) {
   const optionsRef = React.useRef<object | undefined>(options);
   const optionsGettersFromChildRef = React.useRef<
     Record<string, () => object | undefined | null>

package/src/usePreventRemove.tsx

@@ -4,9 +4,9 @@ import * as React from 'react';
 import useLatestCallback from 'use-latest-callback';
 
 import type { EventListenerCallback, EventMapCore } from './types';
-import useNavigation from './useNavigation';
-import usePreventRemoveContext from './usePreventRemoveContext';
-import useRoute from './useRoute';
+import { useNavigation } from './useNavigation';
+import { usePreventRemoveContext } from './usePreventRemoveContext';
+import { useRoute } from './useRoute';
 
 /**
  * Hook to prevent screen from being removed. Can be used to prevent users from leaving the screen.
@@ -14,7 +14,7 @@ import useRoute from './useRoute';
  * @param preventRemove Boolean indicating whether to prevent screen from being removed.
  * @param callback Function which is executed when screen was prevented from being removed.
  */
-export default function usePreventRemove(
+export function UNSTABLE_usePreventRemove(
   preventRemove: boolean,
   callback: (options: { data: { action: NavigationAction } }) => void
 ) {

package/src/usePreventRemoveContext.tsx

@@ -1,8 +1,8 @@
 import * as React from 'react';
 
-import PreventRemoveContext from './PreventRemoveContext';
+import { PreventRemoveContext } from './PreventRemoveContext';
 
-export default function usePreventRemoveContext() {
+export function usePreventRemoveContext() {
   const value = React.useContext(PreventRemoveContext);
 
   if (value == null) {

package/src/useRegisterNavigator.tsx

@@ -7,7 +7,7 @@ import { SingleNavigatorContext } from './EnsureSingleNavigator';
  * Register a navigator in the parent context (either a navigation container or a screen).
  * This is used to prevent multiple navigators under a single container or screen.
  */
-export default function useRegisterNavigator() {
+export function useRegisterNavigator() {
   const [key] = React.useState(() => nanoid());
   const container = React.useContext(SingleNavigatorContext);
 

package/src/useRoute.tsx

@@ -1,7 +1,7 @@
 import type { ParamListBase } from '@react-navigation/routers';
 import * as React from 'react';
 
-import NavigationRouteContext from './NavigationRouteContext';
+import { NavigationRouteContext } from './NavigationRouteContext';
 import type { RouteProp } from './types';
 
 /**
@@ -9,7 +9,7 @@ import type { RouteProp } from './types';
  *
  * @returns Route prop of the parent screen.
  */
-export default function useRoute<T extends RouteProp<ParamListBase>>(): T {
+export function useRoute<T extends RouteProp<ParamListBase>>(): T {
   const route = React.useContext(NavigationRouteContext);
 
   if (route === undefined) {

package/src/useRouteCache.tsx

@@ -20,7 +20,7 @@ export const CHILD_STATE = Symbol('CHILD_STATE');
  * Hook to cache route props for each screen in the navigator.
  * This lets add warnings and modifications to the route object but keep references between renders.
  */
-export default function useRouteCache<State extends NavigationState>(
+export function useRouteCache<State extends NavigationState>(
   routes: State['routes']
 ) {
   // Cache object which holds route objects for each screen

package/src/useScheduleUpdate.tsx

@@ -21,7 +21,7 @@ export const ScheduleUpdateContext = React.createContext<{
  * It lets all subsequent updates access the latest state so it stays correct.
  * Then we call setState during after the component updates.
  */
-export default function useScheduleUpdate(callback: () => void) {
+export function useScheduleUpdate(callback: () => void) {
   const { scheduleUpdate, flushUpdates } = React.useContext(
     ScheduleUpdateContext
   );

package/src/useSyncState.tsx

@@ -5,7 +5,7 @@ const UNINTIALIZED_STATE = {};
 /**
  * This is definitely not compatible with concurrent mode, but we don't have a solution for sync state yet.
  */
-export default function useSyncState<T>(initialState?: (() => T) | T) {
+export function useSyncState<T>(initialState?: (() => T) | T) {
   const stateRef = React.useRef<T>(UNINTIALIZED_STATE as any);
   const isSchedulingRef = React.useRef(false);
   const isMountedRef = React.useRef(true);

package/src/validatePathConfig.tsx

@@ -1,28 +1,72 @@
-const formatToList = (items: string[]) =>
-  items.map((key) => `- ${key}`).join('\n');
+const formatToList = (items: Record<string, string>) =>
+  Object.entries(items)
+    .map(([key, value]) => `- ${key} (${value})`)
+    .join('\n');
 
-export default function validatePathConfig(config: any, root = true) {
-  const validKeys = ['initialRouteName', 'screens'];
+export function validatePathConfig(config: unknown, root = true) {
+  const validation = {
+    path: 'string',
+    initialRouteName: 'string',
+    screens: 'object',
+    ...(root
+      ? null
+      : {
+          exact: 'boolean',
+          stringify: 'object',
+          parse: 'object',
+        }),
+  };
 
-  if (!root) {
-    validKeys.push('path', 'exact', 'stringify', 'parse');
+  if (typeof config !== 'object' || config === null) {
+    throw new Error(
+      `Expected the configuration to be an object, but got ${JSON.stringify(
+        config
+      )}.`
+    );
   }
 
-  const invalidKeys = Object.keys(config).filter(
-    (key) => !validKeys.includes(key)
+  const validationErrors = Object.fromEntries(
+    Object.keys(config)
+      .map((key) => {
+        if (key in validation) {
+          const type = validation[key as keyof typeof validation];
+          // @ts-expect-error: we know the key exists
+          const value = config[key];
+
+          if (typeof value !== type) {
+            return [key, `expected '${type}', got '${typeof value}'`];
+          }
+        } else {
+          return [key, 'extraneous'];
+        }
+
+        return null;
+      })
+      .filter(Boolean) as [string, string][]
   );
 
-  if (invalidKeys.length) {
+  if (Object.keys(validationErrors).length) {
     throw new Error(
       `Found invalid properties in the configuration:\n${formatToList(
-        invalidKeys
-      )}\n\nDid you forget to specify them under a 'screens' property?\n\nYou can only specify the following properties:\n${formatToList(
-        validKeys
-      )}\n\nSee https://reactnavigation.org/docs/configuring-links for more details on how to specify a linking configuration.`
+        validationErrors
+      )}\n\nYou can only specify the following properties:\n${formatToList(
+        validation
+      )}\n\nIf you want to specify configuration for screens, you need to specify them under a 'screens' property.\n\nSee https://reactnavigation.org/docs/configuring-links for more details on how to specify a linking configuration.`
+    );
+  }
+
+  if (
+    root &&
+    'path' in config &&
+    typeof config.path === 'string' &&
+    config.path.includes(':')
+  ) {
+    throw new Error(
+      `Found invalid path '${config.path}'. The 'path' in the top-level configuration cannot contain patterns for params.`
     );
   }
 
-  if (config.screens) {
+  if ('screens' in config && config.screens) {
     Object.entries(config.screens).forEach(([_, value]) => {
       if (typeof value !== 'string') {
         validatePathConfig(value, false);

package/lib/commonjs/fromEntries.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = fromEntries;
-// Object.fromEntries is not available in older iOS versions
-function fromEntries(entries) {
-  return entries.reduce((acc, _ref) => {
-    let [k, v] = _ref;
-    if (acc.hasOwnProperty(k)) {
-      throw new Error(`A value for key '${k}' already exists in the object.`);
-    }
-    acc[k] = v;
-    return acc;
-  }, {});
-}
-//# sourceMappingURL=fromEntries.js.map

package/lib/commonjs/fromEntries.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["fromEntries","entries","reduce","acc","k","v","hasOwnProperty","Error"],"sourceRoot":"../../src","sources":["fromEntries.tsx"],"mappings":";;;;;;AAAA;AACe,SAASA,WAAW,CACjCC,OAA4B,EAC5B;EACA,OAAOA,OAAO,CAACC,MAAM,CAAC,CAACC,GAAG,WAAa;IAAA,IAAX,CAACC,CAAC,EAAEC,CAAC,CAAC;IAChC,IAAIF,GAAG,CAACG,cAAc,CAACF,CAAC,CAAC,EAAE;MACzB,MAAM,IAAIG,KAAK,CAAE,oBAAmBH,CAAE,iCAAgC,CAAC;IACzE;IAEAD,GAAG,CAACC,CAAC,CAAC,GAAGC,CAAC;IACV,OAAOF,GAAG;EACZ,CAAC,EAAE,CAAC,CAAC,CAAiB;AACxB"}

package/lib/module/fromEntries.js

@@ -1,12 +0,0 @@
-// Object.fromEntries is not available in older iOS versions
-export default function fromEntries(entries) {
-  return entries.reduce((acc, _ref) => {
-    let [k, v] = _ref;
-    if (acc.hasOwnProperty(k)) {
-      throw new Error(`A value for key '${k}' already exists in the object.`);
-    }
-    acc[k] = v;
-    return acc;
-  }, {});
-}
-//# sourceMappingURL=fromEntries.js.map

package/lib/module/fromEntries.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["fromEntries","entries","reduce","acc","k","v","hasOwnProperty","Error"],"sourceRoot":"../../src","sources":["fromEntries.tsx"],"mappings":"AAAA;AACA,eAAe,SAASA,WAAW,CACjCC,OAA4B,EAC5B;EACA,OAAOA,OAAO,CAACC,MAAM,CAAC,CAACC,GAAG,WAAa;IAAA,IAAX,CAACC,CAAC,EAAEC,CAAC,CAAC;IAChC,IAAIF,GAAG,CAACG,cAAc,CAACF,CAAC,CAAC,EAAE;MACzB,MAAM,IAAIG,KAAK,CAAE,oBAAmBH,CAAE,iCAAgC,CAAC;IACzE;IAEAD,GAAG,CAACC,CAAC,CAAC,GAAGC,CAAC;IACV,OAAOF,GAAG;EACZ,CAAC,EAAE,CAAC,CAAC,CAAiB;AACxB"}

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

@@ -1,2 +0,0 @@
-export default function fromEntries<K extends string, V>(entries: (readonly [K, V])[]): Record<K, V>;
-//# sourceMappingURL=fromEntries.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"fromEntries.d.ts","sourceRoot":"","sources":["../../../src/fromEntries.tsx"],"names":[],"mappings":"AACA,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EACrD,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,gBAU7B"}

package/src/fromEntries.tsx

@@ -1,13 +0,0 @@
-// Object.fromEntries is not available in older iOS versions
-export default function fromEntries<K extends string, V>(
-  entries: (readonly [K, V])[]
-) {
-  return entries.reduce((acc, [k, v]) => {
-    if (acc.hasOwnProperty(k)) {
-      throw new Error(`A value for key '${k}' already exists in the object.`);
-    }
-
-    acc[k] = v;
-    return acc;
-  }, {} as Record<K, V>);
-}