@amazon-devices/react-navigation__native 7.0.1759135970 → 8.0.9000000000

package/src/useScrollToTop.tsx

@@ -1,7 +1,8 @@
 import {
-  EventArg,
-  NavigationProp,
-  useNavigation,
+  type EventArg,
+  NavigationContext,
+  type NavigationProp,
+  type ParamListBase,
   useRoute,
 } from '@amazon-devices/react-navigation__core';
 import * as React from 'react';
@@ -12,7 +13,7 @@ type ScrollOptions = { x?: number; y?: number; animated?: boolean };
 type ScrollableView =
   | { scrollToTop(): void }
   | { scrollTo(options: ScrollOptions): void }
-  | { scrollToOffset(options: { offset?: number; animated?: boolean }): void }
+  | { scrollToOffset(options: { offset: number; animated?: boolean }): void }
   | { scrollResponderScrollTo(options: ScrollOptions): void };
 
 type ScrollableWrapper =
@@ -38,7 +39,7 @@ function getScrollableNode(ref: React.RefObject<ScrollableWrapper>) {
     // We need to use `getScrollResponder` to get access to the scroll responder
     return ref.current.getScrollResponder();
   } else if ('getNode' in ref.current) {
-    // When a `ScrollView` is wraped in `Animated.createAnimatedComponent`
+    // When a `ScrollView` is wrapped in `Animated.createAnimatedComponent`
     // we need to use `getNode` to get the ref to the actual scrollview.
     // Note that `getNode` is deprecated in newer versions of react-native
     // this is why we check if we already have a scrollable node above.
@@ -48,16 +49,19 @@ function getScrollableNode(ref: React.RefObject<ScrollableWrapper>) {
   }
 }
 
-export default function useScrollToTop(
-  ref: React.RefObject<ScrollableWrapper>
-) {
-  const navigation = useNavigation();
+export function useScrollToTop(ref: React.RefObject<ScrollableWrapper>) {
+  const navigation = React.useContext(NavigationContext);
   const route = useRoute();
 
+  if (navigation === undefined) {
+    throw new Error(
+      "Couldn't find a navigation object. Is your component inside NavigationContainer?"
+    );
+  }
+
   React.useEffect(() => {
-    let tabNavigations: NavigationProp<ReactNavigation.RootParamList>[] = [];
+    const tabNavigations: NavigationProp<ParamListBase>[] = [];
     let currentNavigation = navigation;
-
     // If the screen is nested inside multiple tab navigators, we should scroll to top for any of them
     // So we need to find all the parent tab navigators and add the listeners there
     while (currentNavigation) {
@@ -76,7 +80,7 @@ export default function useScrollToTop(
       return tab.addListener(
         // We don't wanna import tab types here to avoid extra deps
         // in addition, there are multiple tab implementations
-        // @ts-expect-error
+        // @ts-expect-error the `tabPress` event is only available when navigation type is tab
         'tabPress',
         (e: EventArg<'tabPress', true>) => {
           // We should scroll to top only when the screen is focused

package/src/useThenable.tsx

@@ -1,11 +1,12 @@
 import * as React from 'react';
 
-export default function useThenable<T>(create: () => PromiseLike<T>) {
+export function useThenable<T>(create: () => PromiseLike<T>) {
   const [promise] = React.useState(create);
 
   let initialState: [boolean, T | undefined] = [false, undefined];
 
   // Check if our thenable is synchronous
+  // eslint-disable-next-line promise/catch-or-return, promise/always-return
   promise.then((result) => {
     initialState = [true, result];
   });