fix: address cr

src/__tests__/__fixtures__/MockRouter.tsx

@@ -1,5 +1,10 @@
-import {Router, CommonAction, NavigationState, DefaultRouterOptions} from '../../types';
-import { BaseRouter } from '../../index';
+import BaseRouter from '../../BaseRouter';
+import {
+  Router,
+  CommonAction,
+  NavigationState,
+  DefaultRouterOptions,
+} from '../../types';
 
 export type MockActions = CommonAction & {
   type: 'NOOP' | 'REVERSE' | 'UPDATE';

src/__tests__/index.test.tsx

@@ -3,7 +3,7 @@ import { render, act } from 'react-native-testing-library';
 import Screen from '../Screen';
 import NavigationContainer from '../NavigationContainer';
 import useNavigationBuilder from '../useNavigationBuilder';
-import MockRouter, {MockRouterKey} from './__fixtures__/MockRouter';
+import MockRouter, { MockRouterKey } from './__fixtures__/MockRouter';
 
 beforeEach(() => (MockRouterKey.current = 0));
 

src/__tests__/useDescriptors.test.tsx

@@ -14,7 +14,8 @@ it('sets options with options prop as an object', () => {
   const TestNavigator = (props: any) => {
     const { state, descriptors } = useNavigationBuilder<
       NavigationState,
-      { title?: string }
+      { title?: string },
+      any
     >(MockRouter, props);
     const { render, options } = descriptors[state.routes[state.index].key];
 
@@ -57,7 +58,8 @@ it('sets options with options prop as a fuction', () => {
   const TestNavigator = (props: any) => {
     const { state, descriptors } = useNavigationBuilder<
       NavigationState,
-      { title?: string }
+      { title?: string },
+      any
     >(MockRouter, props);
     const { render, options } = descriptors[state.routes[state.index].key];
 
@@ -104,7 +106,8 @@ it('sets initial options with setOptions', () => {
       {
         title?: string;
         color?: string;
-      }
+      },
+      any
     >(MockRouter, props);
     const { render, options } = descriptors[state.routes[state.index].key];
 
@@ -151,10 +154,11 @@ it('sets initial options with setOptions', () => {
 
 it('updates options with setOptions', () => {
   const TestNavigator = (props: any) => {
-    const { state, descriptors } = useNavigationBuilder<NavigationState, any>(
-      MockRouter,
-      props
-    );
+    const { state, descriptors } = useNavigationBuilder<
+      NavigationState,
+      any,
+      any
+    >(MockRouter, props);
     const { render, options } = descriptors[state.routes[state.index].key];
 
     return (

src/types.tsx

@@ -1,5 +1,4 @@
 import * as BaseActions from './BaseActions';
-import * as React from 'react';
 
 export type CommonAction = BaseActions.Action;
 
@@ -73,10 +72,9 @@ export type ActionCreators<Action extends NavigationAction> = {
 
 export type DefaultRouterOptions = {
   initialRouteName?: string;
-  children: React.ReactNode;
 };
 
-export type RouterHelper<
+export type RouterFactory<
   State extends NavigationState,
   Action extends NavigationAction,
   RouterOptions extends DefaultRouterOptions
@@ -90,7 +88,7 @@ export type Router<
    * Initialize the navigation state.
    *
    * @param options.routeNames List of valid route names as defined in the screen components.
-   * @param options.initialRouteName Route to focus in the state.
+   * @param options.routeParamsList Object containing params for each route.
    */
   getInitialState(options: {
     routeNames: string[];
@@ -113,7 +111,7 @@ export type Router<
    *
    * @param state State object to update.
    * @param options.routeNames New list of route names.
-   * @param options.initialRouteName Route to focus in the state.
+   * @param options.routeParamsList Object containing params for each route.
    */
   getStateForRouteNamesChange(
     state: State,

src/useNavigationBuilder.tsx

@@ -11,11 +11,15 @@ import {
   ParamListBase,
   RouteConfig,
   Router,
-  RouterHelper,
+  RouterFactory,
 } from './types';
 import useOnRouteFocus from './useOnRouteFocus';
 import useChildActionListeners from './useChildActionListeners';
 
+type Options = {
+  children: React.ReactNode;
+};
+
 const isArrayEqual = (a: any[], b: any[]) =>
   a.length === b.length && a.every((it, index) => it === b[index]);
 
@@ -54,27 +58,27 @@ const getRouteConfigsFromChildren = <ScreenOptions extends object>(
 export default function useNavigationBuilder<
   State extends NavigationState,
   ScreenOptions extends object,
-  RouterOptions extends DefaultRouterOptions = DefaultRouterOptions
+  RouterOptions extends DefaultRouterOptions
 >(
-  routerCreator: RouterHelper<State, any, RouterOptions>,
-  options: RouterOptions
+  createRouter: RouterFactory<State, any, RouterOptions>,
+  options: Options & RouterOptions
 ) {
+  useRegisterNavigator();
+
+  const { children, ...rest } = options;
   const { current: router } = React.useRef<Router<State, any>>(
-    routerCreator(options)
+    createRouter((rest as unknown) as RouterOptions)
   );
-  useRegisterNavigator();
 
-  const screens = getRouteConfigsFromChildren<ScreenOptions>(
-    options.children
-  ).reduce(
+  const screens = getRouteConfigsFromChildren<ScreenOptions>(children).reduce(
     (acc, curr) => {
       acc[curr.name] = curr;
       return acc;
     },
     {} as { [key: string]: RouteConfig<ParamListBase, string, ScreenOptions> }
   );
 
-  const routeNames = Object.keys(screens)
+  const routeNames = Object.keys(screens);
   const routeParamList = routeNames.reduce(
     (acc, curr) => {
       acc[curr] = screens[curr].initialParams;