@react-navigation/routers 6.1.5 → 7.0.0-alpha.0

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

@@ -1,5 +1,5 @@
 import type { DefaultRouterOptions, NavigationState, ParamListBase, Router } from './types';
-export declare type TabActionType = {
+export type TabActionType = {
     type: 'JUMP_TO';
     payload: {
         name: string;
@@ -8,11 +8,11 @@ export declare type TabActionType = {
     source?: string;
     target?: string;
 };
-export declare type BackBehavior = 'initialRoute' | 'firstRoute' | 'history' | 'order' | 'none';
-export declare type TabRouterOptions = DefaultRouterOptions & {
+export type BackBehavior = 'initialRoute' | 'firstRoute' | 'history' | 'order' | 'none';
+export type TabRouterOptions = DefaultRouterOptions & {
     backBehavior?: BackBehavior;
 };
-export declare type TabNavigationState<ParamList extends ParamListBase> = Omit<NavigationState<ParamList>, 'history'> & {
+export type TabNavigationState<ParamList extends ParamListBase> = Omit<NavigationState<ParamList>, 'history'> & {
     /**
      * Type of the router, in this case, it's tab.
      */
@@ -25,7 +25,7 @@ export declare type TabNavigationState<ParamList extends ParamListBase> = Omit<N
         key: string;
     }[];
 };
-export declare type TabActionHelpers<ParamList extends ParamListBase> = {
+export type TabActionHelpers<ParamList extends ParamListBase> = {
     /**
      * Jump to an existing tab.
      *
@@ -38,3 +38,4 @@ export declare const TabActions: {
     jumpTo(name: string, params?: object): TabActionType;
 };
 export default function TabRouter({ initialRouteName, backBehavior, }: TabRouterOptions): Router<TabNavigationState<ParamListBase>, import("./CommonActions").Action | TabActionType>;
+//# sourceMappingURL=TabRouter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TabRouter.d.ts","sourceRoot":"","sources":["../../../src/TabRouter.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAEV,oBAAoB,EACpB,eAAe,EACf,aAAa,EAGb,MAAM,EACP,MAAM,SAAS,CAAC;AAEjB,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,cAAc,GACd,YAAY,GACZ,SAAS,GACT,OAAO,GACP,MAAM,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG;IACpD,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,SAAS,SAAS,aAAa,IAAI,IAAI,CACpE,eAAe,CAAC,SAAS,CAAC,EAC1B,SAAS,CACV,GAAG;IACF;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,SAAS,SAAS,aAAa,IAAI;IAC9D;;;;;OAKG;IACH,MAAM,CAAC,SAAS,SAAS,OAAO,CAAC,MAAM,SAAS,EAAE,MAAM,CAAC,EACvD,GAAG,IAAI,EAAE,SAAS,SAAS,SAAS,CAAC,SAAS,CAAC,GAC3C,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,GACvE,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,GACpD,IAAI,CAAC;CACT,CAAC;AAIF,eAAO,MAAM,UAAU;iBACR,MAAM,WAAW,MAAM,GAAG,aAAa;CAGrD,CAAC;AA4EF,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,EAChC,gBAAgB,EAChB,YAA2B,GAC5B,EAAE,gBAAgB,+FAiPlB"}

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

@@ -8,3 +8,4 @@ export { StackActions, default as StackRouter } from './StackRouter';
 export type { TabActionHelpers, TabActionType, TabNavigationState, TabRouterOptions, } from './TabRouter';
 export { TabActions, default as TabRouter } from './TabRouter';
 export * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,aAAa,EAAE,CAAC;AAEzB,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,YAAY,EACV,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,mBAAmB,EACnB,YAAY,GACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACxE,YAAY,EACV,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACrE,YAAY,EACV,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AAC/D,cAAc,SAAS,CAAC"}

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

@@ -1,9 +1,9 @@
 import type * as CommonActions from './CommonActions';
-export declare type CommonNavigationAction = CommonActions.Action;
-declare type NavigationRoute<ParamList extends ParamListBase, RouteName extends keyof ParamList> = Route<Extract<RouteName, string>, ParamList[RouteName]> & {
+export type CommonNavigationAction = CommonActions.Action;
+type NavigationRoute<ParamList extends ParamListBase, RouteName extends keyof ParamList> = Route<Extract<RouteName, string>, ParamList[RouteName]> & {
     state?: NavigationState | PartialState<NavigationState>;
 };
-export declare type NavigationState<ParamList extends ParamListBase = ParamListBase> = Readonly<{
+export type NavigationState<ParamList extends ParamListBase = ParamListBase> = Readonly<{
     /**
      * Unique key for the navigation state.
      */
@@ -35,20 +35,20 @@ export declare type NavigationState<ParamList extends ParamListBase = ParamListB
      */
     stale: false;
 }>;
-export declare type InitialState = Readonly<Partial<Omit<NavigationState, 'stale' | 'routes'>> & {
+export type InitialState = Readonly<Partial<Omit<NavigationState, 'stale' | 'routes'>> & {
     routes: (Omit<Route<string>, 'key'> & {
         state?: InitialState;
     })[];
 }>;
-export declare type PartialRoute<R extends Route<string>> = Omit<R, 'key'> & {
+export type PartialRoute<R extends Route<string>> = Omit<R, 'key'> & {
     key?: string;
     state?: PartialState<NavigationState>;
 };
-export declare type PartialState<State extends NavigationState> = Partial<Omit<State, 'stale' | 'routes'>> & Readonly<{
+export type PartialState<State extends NavigationState> = Partial<Omit<State, 'stale' | 'routes'>> & Readonly<{
     stale?: true;
     routes: PartialRoute<Route<State['routeNames'][number]>>[];
 }>;
-export declare type Route<RouteName extends string, Params extends object | undefined = object | undefined> = Readonly<{
+export type Route<RouteName extends string, Params extends object | undefined = object | undefined> = Readonly<{
     /**
      * Unique key for the route.
      */
@@ -73,8 +73,8 @@ export declare type Route<RouteName extends string, Params extends object | unde
      */
     params: Readonly<Params>;
 }>);
-export declare type ParamListBase = Record<string, object | undefined>;
-export declare type NavigationAction = Readonly<{
+export type ParamListBase = Record<string, object | undefined>;
+export type NavigationAction = Readonly<{
     /**
      * Type of the action (e.g. `NAVIGATE`)
      */
@@ -92,25 +92,25 @@ export declare type NavigationAction = Readonly<{
      */
     target?: string;
 }>;
-export declare type ActionCreators<Action extends NavigationAction> = {
+export type ActionCreators<Action extends NavigationAction> = {
     [key: string]: (...args: any) => Action;
 };
-export declare type DefaultRouterOptions<RouteName extends string = string> = {
+export type DefaultRouterOptions<RouteName extends string = string> = {
     /**
      * Name of the route to focus by on initial render.
      * If not specified, usually the first route is used.
      */
     initialRouteName?: RouteName;
 };
-export declare type RouterFactory<State extends NavigationState, Action extends NavigationAction, RouterOptions extends DefaultRouterOptions> = (options: RouterOptions) => Router<State, Action>;
-export declare type RouterConfigOptions = {
+export type RouterFactory<State extends NavigationState, Action extends NavigationAction, RouterOptions extends DefaultRouterOptions> = (options: RouterOptions) => Router<State, Action>;
+export type RouterConfigOptions = {
     routeNames: string[];
     routeParamList: ParamListBase;
     routeGetIdList: Record<string, ((options: {
         params?: Record<string, any>;
     }) => string | undefined) | undefined>;
 };
-export declare type Router<State extends NavigationState, Action extends NavigationAction> = {
+export type Router<State extends NavigationState, Action extends NavigationAction> = {
     /**
      * Type of the router. Should match the `type` property in state.
      * If the type doesn't match, the state will be discarded during rehydration.
@@ -174,3 +174,4 @@ export declare type Router<State extends NavigationState, Action extends Navigat
     actionCreators?: ActionCreators<Action>;
 };
 export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,aAAa,MAAM,iBAAiB,CAAC;AAEtD,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,MAAM,CAAC;AAE1D,KAAK,eAAe,CAClB,SAAS,SAAS,aAAa,EAC/B,SAAS,SAAS,MAAM,SAAS,IAC/B,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,GAAG;IAC5D,KAAK,CAAC,EAAE,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,SAAS,SAAS,aAAa,GAAG,aAAa,IACzE,QAAQ,CAAC;IACP;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,MAAM,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,SAAS,EAAE,MAAM,SAAS,CAAC,EAAE,CAAC;IACtD;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;CACd,CAAC,CAAC;AAEL,MAAM,MAAM,YAAY,GAAG,QAAQ,CACjC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC,GAAG;IACnD,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,YAAY,CAAA;KAAE,CAAC,EAAE,CAAC;CACnE,CACF,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,KAAK,SAAS,eAAe,IAAI,OAAO,CAC/D,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,CAChC,GACC,QAAQ,CAAC;IACP,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;CAC5D,CAAC,CAAC;AAEL,MAAM,MAAM,KAAK,CACf,SAAS,SAAS,MAAM,EACxB,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IACpD,QAAQ,CAAC;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC,GACA,CAAC,SAAS,SAAS,MAAM,GACrB,QAAQ,CAAC;IACP;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC3B,CAAC,GACF,QAAQ,CAAC;IACP;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B,CAAC,CAAC,CAAC;AAEV,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAE/D,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,gBAAgB,IAAI;IAC5D,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,MAAM,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;IACpE;;;OAGG;IACH,gBAAgB,CAAC,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,CACvB,KAAK,SAAS,eAAe,EAC7B,MAAM,SAAS,gBAAgB,EAC/B,aAAa,SAAS,oBAAoB,IACxC,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,EAAE,aAAa,CAAC;IAC9B,cAAc,EAAE,MAAM,CACpB,MAAM,EACJ,CAAC,CAAC,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,KAAK,MAAM,GAAG,SAAS,CAAC,GACnE,SAAS,CACZ,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,MAAM,CAChB,KAAK,SAAS,eAAe,EAC7B,MAAM,SAAS,gBAAgB,IAC7B;IACF;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,KAAK,CAAC;IAErD;;;;;;OAMG;IACH,kBAAkB,CAChB,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,GAAG,KAAK,EACzC,OAAO,EAAE,mBAAmB,GAC3B,KAAK,CAAC;IAET;;;;;;OAMG;IACH,2BAA2B,CACzB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,mBAAmB,GAAG;QAC7B;;;WAGG;QACH,eAAe,EAAE,MAAM,EAAE,CAAC;KAC3B,GACA,KAAK,CAAC;IAET;;;;;OAKG;IACH,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC;IAExD;;;;;;;;OAQG;IACH,iBAAiB,CACf,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,mBAAmB,GAC3B,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAEtC;;;;OAIG;IACH,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC;IAE3D;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;CACzC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@react-navigation/routers",
   "description": "Routers to help build custom navigators",
-  "version": "6.1.5",
+  "version": "7.0.0-alpha.0",
   "keywords": [
     "react",
     "react-native",
@@ -39,9 +39,9 @@
     "nanoid": "^3.1.23"
   },
   "devDependencies": {
-    "del-cli": "^3.0.1",
-    "react-native-builder-bob": "^0.18.1",
-    "typescript": "^4.7.4"
+    "del-cli": "^5.0.0",
+    "react-native-builder-bob": "^0.20.3",
+    "typescript": "^4.9.4"
   },
   "react-native-builder-bob": {
     "source": "src",
@@ -57,5 +57,5 @@
       ]
     ]
   },
-  "gitHead": "4e29403ec63d9304561e296667f6cf15806c316b"
+  "gitHead": "ad722b882e0c40b1d1bc025d70112ddb126f265e"
 }

package/src/BaseRouter.tsx

@@ -74,7 +74,7 @@ const BaseRouter = {
   },
 
   shouldActionChangeFocus(action: CommonNavigationAction) {
-    return action.type === 'NAVIGATE';
+    return action.type === 'NAVIGATE' || action.type === 'NAVIGATE_DEPRECATED';
   },
 };
 

package/src/CommonActions.tsx

@@ -15,21 +15,22 @@ export type Action =
     }
   | {
       type: 'NAVIGATE';
-      payload:
-        | {
-            key: string;
-            name?: undefined;
-            params?: object;
-            path?: string;
-            merge?: boolean;
-          }
-        | {
-            name: string;
-            key?: string;
-            params?: object;
-            path?: string;
-            merge?: boolean;
-          };
+      payload: {
+        name: string;
+        params?: object;
+        path?: string;
+        merge?: boolean;
+      };
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'NAVIGATE_DEPRECATED';
+      payload: {
+        name: string;
+        params?: object;
+        merge?: boolean;
+      };
       source?: string;
       target?: string;
     }
@@ -50,17 +51,12 @@ 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;
-      }
-): Action;
+export function navigate(options: {
+  name: string;
+  params?: object;
+  path?: string;
+  merge?: boolean;
+}): Action;
 // eslint-disable-next-line no-redeclare
 export function navigate(name: string, params?: object): Action;
 // eslint-disable-next-line no-redeclare
@@ -70,9 +66,9 @@ export function navigate(...args: any): Action {
   } else {
     const payload = args[0] || {};
 
-    if (!payload.hasOwnProperty('key') && !payload.hasOwnProperty('name')) {
+    if (!payload.hasOwnProperty('name')) {
       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,6 +76,30 @@ export function navigate(...args: any): Action {
   }
 }
 
+export function navigateDeprecated(
+  ...args:
+    | [name: string]
+    | [name: string, params: object | undefined]
+    | [route: { 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 (!payload.hasOwnProperty('name')) {
+      throw new Error(
+        'You need to specify a name when calling navigate 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): Action {
   return { type: 'RESET', payload: state };
 }

package/src/DrawerRouter.tsx

@@ -220,7 +220,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) {