@exodus/react-navigation-core - npm Package Compare versions

Comparing version 6.1.1-exodus.2 to 6.2.1-exodus.0

lib/commonjs/useNavigationBuilder.js

@@ -467,2 +467,3 @@ "use strict";
   const navigation = (0, _useNavigationHelpers.default)({
+    id: options.id,
     onAction,
@@ -469,0 +470,0 @@ getState,

lib/commonjs/useNavigationCache.js

@@ -106,2 +106,11 @@ "use strict";
         dispatch: thunk => withStack(() => dispatch(thunk)),
+        getParent: id => {
+          if (id !== undefined && id === rest.getId()) {
+            // If the passed id is the same as the current navigation id,
+            // we return the cached navigation object for the relevant route
+            return acc[route.key];
+          }
+
+          return rest.getParent(id);
+        },
         setOptions: options => setOptions(o => ({ ...o,
@@ -108,0 +117,0 @@ [route.key]: { ...o[route.key],

lib/commonjs/useNavigationHelpers.js

@@ -34,2 +34,3 @@ "use strict";
   let {
+    id: navigatorId,
     onAction,
@@ -63,3 +64,3 @@ getState,
     }, {});
-    return { ...parentNavigationHelpers,
+    const navigationHelpers = { ...parentNavigationHelpers,
       ...helpers,
@@ -77,7 +78,21 @@ dispatch,
       },
-      getParent: () => parentNavigationHelpers,
+      getId: () => navigatorId,
+      getParent: id => {
+        if (id !== undefined) {
+          let current = navigationHelpers;
+
+          while (current && id !== current.getId()) {
+            current = current.getParent();
+          }
+
+          return current;
+        }
+
+        return parentNavigationHelpers;
+      },
       getState
     };
-  }, [emitter.emit, getState, onAction, onUnhandledAction, parentNavigationHelpers, router]);
+    return navigationHelpers;
+  }, [navigatorId, emitter.emit, getState, onAction, onUnhandledAction, parentNavigationHelpers, router]);
 }
 //# sourceMappingURL=useNavigationHelpers.js.map

lib/module/useNavigationBuilder.js

@@ -429,2 +429,3 @@ import { CommonActions } from '@react-navigation/routers';
   const navigation = useNavigationHelpers({
+    id: options.id,
     onAction,
@@ -431,0 +432,0 @@ getState,

lib/module/useNavigationCache.js

@@ -91,2 +91,11 @@ import { CommonActions } from '@react-navigation/routers';
         dispatch: thunk => withStack(() => dispatch(thunk)),
+        getParent: id => {
+          if (id !== undefined && id === rest.getId()) {
+            // If the passed id is the same as the current navigation id,
+            // we return the cached navigation object for the relevant route
+            return acc[route.key];
+          }
+
+          return rest.getParent(id);
+        },
         setOptions: options => setOptions(o => ({ ...o,
@@ -93,0 +102,0 @@ [route.key]: { ...o[route.key],

lib/module/useNavigationHelpers.js

@@ -16,2 +16,3 @@ import { CommonActions } from '@react-navigation/routers';
   let {
+    id: navigatorId,
     onAction,
@@ -45,3 +46,3 @@ getState,
     }, {});
-    return { ...parentNavigationHelpers,
+    const navigationHelpers = { ...parentNavigationHelpers,
       ...helpers,
@@ -59,7 +60,21 @@ dispatch,
       },
-      getParent: () => parentNavigationHelpers,
+      getId: () => navigatorId,
+      getParent: id => {
+        if (id !== undefined) {
+          let current = navigationHelpers;
+
+          while (current && id !== current.getId()) {
+            current = current.getParent();
+          }
+
+          return current;
+        }
+
+        return parentNavigationHelpers;
+      },
       getState
     };
-  }, [emitter.emit, getState, onAction, onUnhandledAction, parentNavigationHelpers, router]);
+    return navigationHelpers;
+  }, [navigatorId, emitter.emit, getState, onAction, onUnhandledAction, parentNavigationHelpers, router]);
 }
 //# sourceMappingURL=useNavigationHelpers.js.map

lib/typescript/src/NavigationContext.d.ts

@@ -7,3 +7,3 @@ import type { ParamListBase } from '@react-navigation/routers';
  */
-declare const NavigationContext: React.Context<NavigationProp<ParamListBase, string, Readonly<{
+declare const NavigationContext: React.Context<NavigationProp<ParamListBase, string, undefined, Readonly<{
     key: string;
@@ -10,0 +10,0 @@ index: number;

lib/typescript/src/SceneView.d.ts

@@ -8,3 +8,3 @@ /// <reference types="react" />
     };
-    navigation: NavigationProp<ParamListBase, string, State, ScreenOptions>;
+    navigation: NavigationProp<ParamListBase, string, string | undefined, State, ScreenOptions>;
     route: Route<string>;
@@ -11,0 +11,0 @@ routeState: NavigationState | PartialState<NavigationState> | undefined;

lib/typescript/src/types.d.ts

@@ -12,2 +12,6 @@ import type { DefaultRouterOptions, InitialState, NavigationAction, NavigationState, ParamListBase, PartialState, Route } from '@react-navigation/routers';
     /**
+     * Optional ID for the navigator. Can be used with `navigation.getParent(id)` to refer to a parent.
+     */
+    id?: string;
+    /**
      * Children React Elements to extract the route configuration from.
@@ -115,3 +119,3 @@ * Only `Screen`, `Group` and `React.Fragment` are supported as children.
 };
-export declare class PrivateValueStore<A, B, C> {
+export declare class PrivateValueStore<T extends [any, any, any]> {
     /**
@@ -127,7 +131,3 @@ * UGLY HACK! DO NOT USE THE TYPE!!!
      */
-    protected ''?: {
-        a: A;
-        b: B;
-        c: C;
-    };
+    protected ''?: T;
 }
@@ -187,6 +187,15 @@ declare type NavigationHelpersCommon<ParamList extends ParamListBase, State extends NavigationState = NavigationState> = {
     /**
-     * Returns the navigation prop from the parent navigator,
+     * Returns the name of the navigator specified in the `name` prop.
+     * If no name is specified, returns `undefined`.
      */
-    getParent<T = NavigationProp<ParamListBase> | undefined>(): T;
+    getId(): string | undefined;
     /**
+     * Returns the navigation helpers from a parent navigator based on the ID.
+     * If an ID is provided, the navigation helper from the parent navigator with matching ID (including current) will be returned.
+     * If no ID is provided, the navigation helper from the immediate parent navigator will be returned.
+     *
+     * @param id Optional ID of a parent navigator.
+     */
+    getParent<T = NavigationHelpers<ParamListBase> | undefined>(id?: string): T;
+    /**
      * Returns the navigator's state.
@@ -196,3 +205,3 @@ * Note that this method doesn't re-render screen when the result changes. So don't use it in `render`.
     getState(): State;
-} & PrivateValueStore<ParamList, keyof ParamList, {}>;
+} & PrivateValueStore<[ParamList, unknown, unknown]>;
 export declare type NavigationHelpers<ParamList extends ParamListBase, EventMap extends EventMapBase = {}> = NavigationHelpersCommon<ParamList> & EventEmitter<EventMap> & {
@@ -231,4 +240,12 @@ /**
 };
-export declare type NavigationProp<ParamList extends {}, RouteName extends keyof ParamList = Keyof<ParamList>, State extends NavigationState = NavigationState<ParamList>, ScreenOptions extends {} = {}, EventMap extends EventMapBase = {}> = NavigationHelpersCommon<ParamList, State> & {
+export declare type NavigationProp<ParamList extends {}, RouteName extends keyof ParamList = Keyof<ParamList>, NavigatorID extends string | undefined = undefined, State extends NavigationState = NavigationState<ParamList>, ScreenOptions extends {} = {}, EventMap extends EventMapBase = {}> = Omit<NavigationHelpersCommon<ParamList, State>, 'getParent'> & {
     /**
+     * Returns the navigation prop from a parent navigator based on the ID.
+     * If an ID is provided, the navigation prop from the parent navigator with matching ID (including current) will be returned.
+     * If no ID is provided, the navigation prop from the immediate parent navigator will be returned.
+     *
+     * @param id Optional ID of a parent navigator.
+     */
+    getParent<T = NavigationProp<ParamListBase> | undefined>(id?: NavigatorID): T;
+    /**
      * Update the param object for the route.
@@ -247,5 +264,5 @@ * The new params will be shallow merged with the old one.
     setOptions(options: Partial<ScreenOptions>): void;
-} & EventConsumer<EventMap & EventMapCore<State>> & PrivateValueStore<ParamList, RouteName, EventMap>;
+} & EventConsumer<EventMap & EventMapCore<State>> & PrivateValueStore<[ParamList, RouteName, EventMap]>;
 export declare type RouteProp<ParamList extends ParamListBase, RouteName extends keyof ParamList = Keyof<ParamList>> = Route<Extract<RouteName, string>, ParamList[RouteName]>;
-export declare type CompositeNavigationProp<A extends NavigationProp<ParamListBase, string, any, any>, B extends NavigationHelpersCommon<ParamListBase, any>> = Omit<A & B, keyof NavigationProp<any>> & NavigationProp<
+export declare type CompositeNavigationProp<A extends NavigationProp<ParamListBase, string, any, any, any>, B extends NavigationHelpersCommon<ParamListBase, any>> = Omit<A & B, keyof NavigationProp<any>> & NavigationProp<
 /**
@@ -262,5 +279,9 @@ * Param list from both navigation objects needs to be combined
 /**
+ * ID from both navigation objects needs to be combined for `getParent`
+ */
+(A extends NavigationProp<any, any, infer I> ? I : never) | (B extends NavigationProp<any, any, infer J> ? J : never), 
+/**
  * The type of state should refer to the state specified in the first type
  */
-A extends NavigationProp<any, any, infer S> ? S : NavigationState, 
+A extends NavigationProp<any, any, any, infer S> ? S : NavigationState, 
 /**
@@ -270,3 +291,3 @@ * Screen options from both navigation objects needs to be combined
  */
-(A extends NavigationProp<any, any, any, infer O> ? O : {}) & (B extends NavigationProp<any, any, any, infer P> ? P : {}), 
+(A extends NavigationProp<any, any, any, any, infer O> ? O : {}) & (B extends NavigationProp<any, any, any, any, infer P> ? P : {}), 
 /**
@@ -276,8 +297,8 @@ * Event consumer config should refer to the config specified in the first type
  */
-A extends NavigationProp<any, any, any, any, infer E> ? E : {}>;
+A extends NavigationProp<any, any, any, any, any, infer E> ? E : {}>;
 export declare type CompositeScreenProps<A extends {
-    navigation: NavigationProp<ParamListBase, string, any, any>;
+    navigation: NavigationProp<ParamListBase, string, string | undefined, any, any, any>;
     route: RouteProp<ParamListBase>;
 }, B extends {
-    navigation: NavigationHelpersCommon<ParamListBase, any>;
+    navigation: NavigationHelpersCommon<any, any>;
 }> = {
@@ -287,3 +308,3 @@ navigation: CompositeNavigationProp<A['navigation'], B['navigation']>;
 };
-export declare type Descriptor<ScreenOptions extends {}, Navigation extends NavigationProp<any, any, any, any, any>, Route extends RouteProp<any, any>> = {
+export declare type Descriptor<ScreenOptions extends {}, Navigation extends NavigationProp<any, any, any, any, any, any>, Route extends RouteProp<any, any>> = {
     /**
@@ -290,0 +311,0 @@ * Render the component associated with this route.

lib/typescript/src/useDescriptors.d.ts

@@ -41,3 +41,3 @@ import type { NavigationAction, NavigationState, ParamListBase, Router } from '@react-navigation/routers';
  */
-export default function useDescriptors<State extends NavigationState, ActionHelpers extends Record<string, () => void>, ScreenOptions extends {}, EventMap extends EventMapBase>({ state, screens, navigation, screenOptions, defaultScreenOptions, onAction, getState, setState, addListener, addKeyedListener, onRouteFocus, router, emitter, }: Options<State, ScreenOptions, EventMap>): Record<string, Descriptor<ScreenOptions, {
+export default function useDescriptors<State extends NavigationState, ActionHelpers extends Record<string, () => void>, ScreenOptions extends {}, EventMap extends EventMapBase>({ state, screens, navigation, screenOptions, defaultScreenOptions, onAction, getState, setState, addListener, addKeyedListener, onRouteFocus, router, emitter, }: Options<State, ScreenOptions, EventMap>): Record<string, Descriptor<ScreenOptions, Omit<{
     dispatch(action: Readonly<{
@@ -69,3 +69,7 @@ type: string;
     canGoBack(): boolean;
-    getParent<T = NavigationProp<ParamListBase, string, Readonly<{
+    getId(): string | undefined;
+    getParent<T = NavigationHelpers<ParamListBase, {}> | undefined>(id?: string | undefined): T;
+    getState(): State;
+} & import("./types").PrivateValueStore<[ParamListBase, unknown, unknown]>, "getParent"> & {
+    getParent<T_1 = NavigationProp<ParamListBase, string, undefined, Readonly<{
         key: string;
@@ -86,8 +90,6 @@ index: number;
         stale: false;
-    }>, {}, {}> | undefined>(): T;
-    getState(): State;
-} & import("./types").PrivateValueStore<ParamListBase, string, {}> & {
+    }>, {}, {}> | undefined>(id?: string | undefined): T_1;
     setParams(params: Partial<object | undefined>): void;
     setOptions(options: Partial<ScreenOptions>): void;
-} & import("./types").EventConsumer<EventMap & import("./types").EventMapCore<State>> & import("./types").PrivateValueStore<ParamListBase, string, EventMap> & ActionHelpers, RouteProp<ParamListBase, string>>>;
+} & import("./types").EventConsumer<EventMap & import("./types").EventMapCore<State>> & import("./types").PrivateValueStore<[ParamListBase, string, EventMap]> & ActionHelpers, RouteProp<ParamListBase, string>>>;
 export {};

lib/typescript/src/useNavigationBuilder.d.ts

@@ -88,19 +88,4 @@ import { DefaultRouterOptions, NavigationState, ParamListBase, PartialState, RouterFactory } from '@react-navigation/routers';
         canGoBack(): boolean;
-        getParent<T = import("./types").NavigationProp<ParamListBase, string, Readonly<{
-            key: string;
-            index: number;
-            routeNames: string[];
-            history?: unknown[] | undefined;
-            routes: (Readonly<{
-                key: string;
-                name: string;
-                path?: string | undefined;
-            }> & Readonly<{
-                params?: Readonly<object | undefined>;
-            }> & {
-                state?: Readonly<any> | PartialState<Readonly<any>> | undefined;
-            })[];
-            type: string;
-            stale: false;
-        }>, {}, {}> | undefined>(): T;
+        getId(): string | undefined;
+        getParent<T = import("./types").NavigationHelpers<ParamListBase, {}> | undefined>(id?: string | undefined): T;
         getState(): Readonly<{
@@ -123,5 +108,6 @@ key: string;
         }>;
-    } & PrivateValueStore<ParamListBase, string, {}> & import("./types").EventEmitter<EventMap> & {
+    } & PrivateValueStore<[ParamListBase, unknown, unknown]> & import("./types").EventEmitter<EventMap> & {
         setParams<RouteName_2 extends string>(params: Partial<object | undefined>): void;
-    } & {
+    } & ActionHelpers;
+    descriptors: Record<string, import("./types").Descriptor<ScreenOptions, Omit<{
         dispatch(action: Readonly<{
@@ -132,51 +118,2 @@ type: string;
             target?: string | undefined;
-        }> | ((state: any) => Readonly<{
-            type: string;
-            payload?: object | undefined;
-            source?: string | undefined;
-            target?: string | undefined;
-        }>)): void;
-        navigate<RouteName extends string>(...args: [screen: RouteName] | [screen: RouteName, params: object | undefined]): void;
-        navigate<RouteName_1 extends string>(options: {
-            key: string;
-            params?: object | undefined;
-            merge?: boolean | undefined;
-        } | {
-            name: RouteName_1;
-            key?: string | undefined;
-            params: object | undefined;
-            merge?: boolean | undefined;
-        }): void;
-        reset(state: any): void;
-        goBack(): void;
-        isFocused(): boolean;
-        canGoBack(): boolean;
-        getParent<T = import("./types").NavigationProp<ParamListBase, string, Readonly<{
-            key: string;
-            index: number;
-            routeNames: string[];
-            history?: unknown[] | undefined;
-            routes: (Readonly<{
-                key: string;
-                name: string;
-                path?: string | undefined;
-            }> & Readonly<{
-                params?: Readonly<object | undefined>;
-            }> & {
-                state?: Readonly<any> | PartialState<Readonly<any>> | undefined;
-            })[];
-            type: string;
-            stale: false;
-        }>, {}, {}> | undefined>(): T;
-        getState(): any;
-    } & {
-        setParams(params: Partial<object | undefined>): void;
-        setOptions(options: Partial<any>): void;
-    } & import("./types").EventConsumer<any> & PrivateValueStore<ParamListBase, string, any> & ActionHelpers;
-    descriptors: Record<string, import("./types").Descriptor<ScreenOptions, {
-        dispatch(action: Readonly<{
-            type: string;
-            payload?: object | undefined;
-            source?: string | undefined;
-            target?: string | undefined;
         }> | ((state: State) => Readonly<{
@@ -203,3 +140,7 @@ type: string;
         canGoBack(): boolean;
-        getParent<T = import("./types").NavigationProp<ParamListBase, string, Readonly<{
+        getId(): string | undefined;
+        getParent<T = import("./types").NavigationHelpers<ParamListBase, {}> | undefined>(id?: string | undefined): T;
+        getState(): State;
+    } & PrivateValueStore<[ParamListBase, unknown, unknown]>, "getParent"> & {
+        getParent<T_1 = import("./types").NavigationProp<ParamListBase, string, undefined, Readonly<{
             key: string;
@@ -220,9 +161,7 @@ index: number;
             stale: false;
-        }>, {}, {}> | undefined>(): T;
-        getState(): State;
-    } & PrivateValueStore<ParamListBase, string, {}> & {
+        }>, {}, {}> | undefined>(id?: string | undefined): T_1;
         setParams(params: Partial<object | undefined>): void;
         setOptions(options: Partial<ScreenOptions>): void;
-    } & import("./types").EventConsumer<EventMap & EventMapCore<State>> & PrivateValueStore<ParamListBase, string, EventMap> & ActionHelpers, import("./types").RouteProp<ParamListBase, string>>>;
+    } & import("./types").EventConsumer<EventMap & EventMapCore<State>> & PrivateValueStore<[ParamListBase, string, EventMap]> & ActionHelpers, import("./types").RouteProp<ParamListBase, string>>>;
     NavigationContent: (rest: Omit<React.ProviderProps<import("./types").NavigationHelpers<ParamListBase, {}> | undefined>, "value">) => JSX.Element;
 };

lib/typescript/src/useNavigationCache.d.ts

@@ -12,3 +12,3 @@ import { NavigationAction, NavigationState, ParamListBase, Router } from '@react-navigation/routers';
 };
-declare type NavigationCache<State extends NavigationState, ScreenOptions extends {}, EventMap extends Record<string, any>> = Record<string, NavigationProp<ParamListBase, string, State, ScreenOptions, EventMap>>;
+declare type NavigationCache<State extends NavigationState, ScreenOptions extends {}, EventMap extends Record<string, any>> = Record<string, NavigationProp<ParamListBase, string, string | undefined, State, ScreenOptions, EventMap>>;
 /**
@@ -15,0 +15,0 @@ * Hook to cache navigation objects for each screen in the navigator.

lib/typescript/src/useNavigationHelpers.d.ts

 import { NavigationAction, NavigationState, ParamListBase, Router } from '@react-navigation/routers';
-import { NavigationProp, PrivateValueStore } from './types';
+import { NavigationHelpers, PrivateValueStore } from './types';
 import type { NavigationEventEmitter } from './useEventEmitter';
 declare type Options<State extends NavigationState, Action extends NavigationAction> = {
+    id: string | undefined;
     onAction: (action: NavigationAction) => boolean;
@@ -14,3 +15,3 @@ getState: () => State;
  */
-export default function useNavigationHelpers<State extends NavigationState, ActionHelpers extends Record<string, () => void>, Action extends NavigationAction, EventMap extends Record<string, any>>({ onAction, getState, emitter, router }: Options<State, Action>): {
+export default function useNavigationHelpers<State extends NavigationState, ActionHelpers extends Record<string, () => void>, Action extends NavigationAction, EventMap extends Record<string, any>>({ id: navigatorId, onAction, getState, emitter, router, }: Options<State, Action>): {
     dispatch(action: Readonly<{
@@ -90,19 +91,4 @@ type: string;
     canGoBack(): boolean;
-    getParent<T = NavigationProp<ParamListBase, string, Readonly<{
-        key: string;
-        index: number;
-        routeNames: string[];
-        history?: unknown[] | undefined;
-        routes: (Readonly<{
-            key: string;
-            name: string;
-            path?: string | undefined;
-        }> & Readonly<{
-            params?: Readonly<object | undefined>;
-        }> & {
-            state?: Readonly<any> | import("@react-navigation/routers").PartialState<Readonly<any>> | undefined;
-        })[];
-        type: string;
-        stale: false;
-    }>, {}, {}> | undefined>(): T;
+    getId(): string | undefined;
+    getParent<T = NavigationHelpers<ParamListBase, {}> | undefined>(id?: string | undefined): T;
     getState(): Readonly<{
@@ -125,53 +111,5 @@ key: string;
     }>;
-} & PrivateValueStore<ParamListBase, string, {}> & import("./types").EventEmitter<EventMap> & {
+} & PrivateValueStore<[ParamListBase, unknown, unknown]> & import("./types").EventEmitter<EventMap> & {
     setParams<RouteName_2 extends string>(params: Partial<object | undefined>): void;
-} & {
-    dispatch(action: Readonly<{
-        type: string;
-        payload?: object | undefined;
-        source?: string | undefined;
-        target?: string | undefined;
-    }> | ((state: any) => Readonly<{
-        type: string;
-        payload?: object | undefined;
-        source?: string | undefined;
-        target?: string | undefined;
-    }>)): void;
-    navigate<RouteName extends string>(...args: [screen: RouteName] | [screen: RouteName, params: object | undefined]): void;
-    navigate<RouteName_1 extends string>(options: {
-        key: string;
-        params?: object | undefined;
-        merge?: boolean | undefined;
-    } | {
-        name: RouteName_1;
-        key?: string | undefined;
-        params: object | undefined;
-        merge?: boolean | undefined;
-    }): void;
-    reset(state: any): void;
-    goBack(): void;
-    isFocused(): boolean;
-    canGoBack(): boolean;
-    getParent<T = NavigationProp<ParamListBase, string, Readonly<{
-        key: string;
-        index: number;
-        routeNames: string[];
-        history?: unknown[] | undefined;
-        routes: (Readonly<{
-            key: string;
-            name: string;
-            path?: string | undefined;
-        }> & Readonly<{
-            params?: Readonly<object | undefined>;
-        }> & {
-            state?: Readonly<any> | import("@react-navigation/routers").PartialState<Readonly<any>> | undefined;
-        })[];
-        type: string;
-        stale: false;
-    }>, {}, {}> | undefined>(): T;
-    getState(): any;
-} & {
-    setParams(params: Partial<object | undefined>): void;
-    setOptions(options: Partial<any>): void;
-} & import("./types").EventConsumer<any> & PrivateValueStore<ParamListBase, string, any> & ActionHelpers;
+} & ActionHelpers;
 export {};

package.json

 {
   "name": "@exodus/react-navigation-core",
   "description": "Core utilities for building navigators",
-  "version": "6.1.1-exodus.2",
+  "version": "6.2.1-exodus.0",
   "keywords": [
@@ -6,0 +6,0 @@ "react",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

539404

increased by0.21%

Lines of code

12951

increased by0.18%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes