@amazon-devices/react-navigation__routers 7.0.1759135970 → 8.0.9000000000-rn-83

package/src/CommonActions.tsx

@@ -7,72 +7,122 @@ type ResetState =
       routes: Omit<Route<string>, 'key'>[];
     });
 
+type GoBackAction = {
+  type: 'GO_BACK';
+  source?: string;
+  target?: string;
+};
+
+type NavigateAction = {
+  type: 'NAVIGATE';
+  payload: {
+    name: string;
+    params?: object;
+    path?: string;
+    merge?: boolean;
+    pop?: boolean;
+  };
+  source?: string;
+  target?: string;
+};
+
+type NavigateDeprecatedAction = {
+  type: 'NAVIGATE_DEPRECATED';
+  payload: {
+    name: string;
+    params?: object;
+    merge?: boolean;
+  };
+  source?: string;
+  target?: string;
+};
+
+type ResetAction = {
+  type: 'RESET';
+  payload: ResetState | undefined;
+  source?: string;
+  target?: string;
+};
+
+type SetParamsAction = {
+  type: 'SET_PARAMS';
+  payload: { params?: object };
+  source?: string;
+  target?: string;
+};
+
+type ReplaceParamsAction = {
+  type: 'REPLACE_PARAMS';
+  payload: { params?: object };
+  source?: string;
+  target?: string;
+};
+
+type PreloadAction = {
+  type: 'PRELOAD';
+  payload: {
+    name: string;
+    params?: object;
+  };
+  source?: string;
+  target?: string;
+};
+
 export type Action =
-  | {
-      type: 'GO_BACK';
-      source?: string;
-      target?: string;
-    }
-  | {
-      type: 'NAVIGATE';
-      payload:
-        | {
-            key: string;
-            name?: undefined;
-            params?: object;
-            path?: string;
-            merge?: boolean;
-          }
-        | {
-            name: string;
-            key?: string;
-            params?: object;
-            path?: string;
-            merge?: boolean;
-          };
-      source?: string;
-      target?: string;
-    }
-  | {
-      type: 'RESET';
-      payload: ResetState | undefined;
-      source?: string;
-      target?: string;
-    }
-  | {
-      type: 'SET_PARAMS';
-      payload: { params?: object };
-      source?: string;
-      target?: string;
-    };
+  | GoBackAction
+  | NavigateAction
+  | NavigateDeprecatedAction
+  | ResetAction
+  | SetParamsAction
+  | ReplaceParamsAction
+  | PreloadAction;
 
 export function goBack(): Action {
   return { type: 'GO_BACK' };
 }
 
 export function navigate(
-  options:
-    | { key: string; params?: object; path?: string; merge?: boolean }
-    | {
-        name: string;
-        key?: string;
-        params?: object;
-        path?: string;
-        merge?: boolean;
-      }
+  name: string,
+  params?: object,
+  options?: {
+    merge?: boolean;
+    pop?: boolean;
+  }
 ): Action;
-// eslint-disable-next-line no-redeclare
-export function navigate(name: string, params?: object): Action;
-// eslint-disable-next-line no-redeclare
+
+export function navigate(options: {
+  name: string;
+  params?: object;
+  path?: string;
+  merge?: boolean;
+  pop?: boolean;
+}): Action;
+
 export function navigate(...args: any): Action {
   if (typeof args[0] === 'string') {
-    return { type: 'NAVIGATE', payload: { name: args[0], params: args[1] } };
+    const [name, params, options] = args;
+
+    if (typeof options === 'boolean') {
+      console.warn(
+        `Passing a boolean as the third argument to 'navigate' is deprecated. Pass '{ merge: true }' instead.`
+      );
+    }
+
+    return {
+      type: 'NAVIGATE',
+      payload: {
+        name,
+        params,
+        merge: typeof options === 'boolean' ? options : options?.merge,
+        pop: options?.pop,
+      },
+    };
   } else {
     const payload = args[0] || {};
 
-    if (!payload.hasOwnProperty('key') && !payload.hasOwnProperty('name')) {
+    if (!('name' in payload)) {
       throw new Error(
-        'You need to specify name or key when calling navigate with an object as the argument. See https://reactnavigation.org/docs/navigation-actions#navigate for usage.'
+        'You need to specify a name when calling navigate with an object as the argument. See https://reactnavigation.org/docs/navigation-actions#navigate for usage.'
       );
     }
 
@@ -80,10 +130,51 @@ export function navigate(...args: any): Action {
   }
 }
 
-export function reset(state: ResetState | undefined): Action {
-  return { type: 'RESET', payload: state };
+export function navigateDeprecated(
+  ...args:
+    | [name: string]
+    | [name: string, params: object | undefined]
+    | [options: { name: string; params?: object }]
+): Action {
+  if (typeof args[0] === 'string') {
+    return {
+      type: 'NAVIGATE_DEPRECATED',
+      payload: { name: args[0], params: args[1] },
+    };
+  } else {
+    const payload = args[0] || {};
+
+    if (!('name' in payload)) {
+      throw new Error(
+        'You need to specify a name when calling navigateDeprecated with an object as the argument. See https://reactnavigation.org/docs/navigation-actions#navigatelegacy for usage.'
+      );
+    }
+
+    return { type: 'NAVIGATE_DEPRECATED', payload };
+  }
+}
+
+export function reset(state: ResetState | undefined) {
+  return { type: 'RESET', payload: state } as const satisfies ResetAction;
+}
+
+export function setParams(params: object) {
+  return {
+    type: 'SET_PARAMS',
+    payload: { params },
+  } as const satisfies SetParamsAction;
+}
+
+export function replaceParams(params: object) {
+  return {
+    type: 'REPLACE_PARAMS',
+    payload: { params },
+  } as const satisfies ReplaceParamsAction;
 }
 
-export function setParams(params: object): Action {
-  return { type: 'SET_PARAMS', payload: { params } };
+export function preload(name: string, params?: object) {
+  return {
+    type: 'PRELOAD',
+    payload: { name, params },
+  } as const satisfies PreloadAction;
 }

package/src/DrawerRouter.tsx

@@ -1,11 +1,12 @@
 import { nanoid } from 'nanoid/non-secure';
 
-import TabRouter, {
-  TabActionHelpers,
+import {
+  type TabActionHelpers,
   TabActions,
-  TabActionType,
-  TabNavigationState,
-  TabRouterOptions,
+  type TabActionType,
+  type TabNavigationState,
+  TabRouter,
+  type TabRouterOptions,
 } from './TabRouter';
 import type {
   CommonNavigationAction,
@@ -68,18 +69,18 @@ export type DrawerActionHelpers<ParamList extends ParamListBase> =
 
 export const DrawerActions = {
   ...TabActions,
-  openDrawer(): DrawerActionType {
-    return { type: 'OPEN_DRAWER' };
+  openDrawer() {
+    return { type: 'OPEN_DRAWER' } as const satisfies DrawerActionType;
   },
-  closeDrawer(): DrawerActionType {
-    return { type: 'CLOSE_DRAWER' };
+  closeDrawer() {
+    return { type: 'CLOSE_DRAWER' } as const satisfies DrawerActionType;
   },
-  toggleDrawer(): DrawerActionType {
-    return { type: 'TOGGLE_DRAWER' };
+  toggleDrawer() {
+    return { type: 'TOGGLE_DRAWER' } as const satisfies DrawerActionType;
   },
 };
 
-export default function DrawerRouter({
+export function DrawerRouter({
   defaultStatus = 'closed',
   ...rest
 }: DrawerRouterOptions): Router<
@@ -220,7 +221,8 @@ export default function DrawerRouter({
           return addDrawerToHistory(state);
 
         case 'JUMP_TO':
-        case 'NAVIGATE': {
+        case 'NAVIGATE':
+        case 'NAVIGATE_DEPRECATED': {
           const result = router.getStateForAction(state, action, options);
 
           if (result != null && result.index !== state.index) {