@amazon-devices/react-navigation__native 8.0.9000000000 → 8.0.9000000002

package/src/Link.tsx

@@ -1,69 +0,0 @@
-import { useTheme } from '@amazon-devices/react-navigation__core';
-import * as React from 'react';
-import {
-  type GestureResponderEvent,
-  Platform,
-  Text,
-  type TextProps,
-} from 'react-native';
-
-import { type LinkProps, useLinkProps } from './useLinkProps';
-
-type Props<ParamList extends ReactNavigation.RootParamList> =
-  LinkProps<ParamList> &
-    Omit<TextProps, 'disabled'> & {
-      target?: string;
-      onPress?: (
-        e:
-          | React.MouseEvent<HTMLAnchorElement, MouseEvent>
-          | GestureResponderEvent
-      ) => void;
-      disabled?: boolean | null;
-      children: React.ReactNode;
-    };
-
-/**
- * Component to render link to another screen using a path.
- * Uses an anchor tag on the web.
- *
- * @param props.screen Name of the screen to navigate to (e.g. `'Feeds'`).
- * @param props.params Params to pass to the screen to navigate to (e.g. `{ sort: 'hot' }`).
- * @param props.href Optional absolute path to use for the href (e.g. `/feeds/hot`).
- * @param props.action Optional action to use for in-page navigation. By default, the path is parsed to an action based on linking config.
- * @param props.children Child elements to render the content.
- */
-export function Link<ParamList extends ReactNavigation.RootParamList>({
-  screen,
-  params,
-  action,
-  href,
-  style,
-  ...rest
-}: Props<ParamList>) {
-  const { colors, fonts } = useTheme();
-  // @ts-expect-error: This is already type-checked by the prop types
-  const props = useLinkProps<ParamList>({ screen, params, action, href });
-
-  const onPress = (
-    e: React.MouseEvent<HTMLAnchorElement, MouseEvent> | GestureResponderEvent
-  ) => {
-    if ('onPress' in rest) {
-      rest.onPress?.(e);
-    }
-
-    // Let user prevent default behavior
-    if (!e.defaultPrevented) {
-      props.onPress(e);
-    }
-  };
-
-  return React.createElement(Text, {
-    ...props,
-    ...rest,
-    ...Platform.select({
-      web: { onClick: onPress } as any,
-      default: { onPress },
-    }),
-    style: [{ color: colors.primary }, fonts.regular, style],
-  });
-}

package/src/LinkingContext.tsx

@@ -1,16 +0,0 @@
-import type { ParamListBase } from '@amazon-devices/react-navigation__core';
-import * as React from 'react';
-
-import type { LinkingOptions } from './types';
-
-const MISSING_CONTEXT_ERROR = "Couldn't find a LinkingContext context.";
-
-export const LinkingContext = React.createContext<{
-  options?: LinkingOptions<ParamListBase>;
-}>({
-  get options(): any {
-    throw new Error(MISSING_CONTEXT_ERROR);
-  },
-});
-
-LinkingContext.displayName = 'LinkingContext';

package/src/LocaleDirContext.tsx

@@ -1,7 +0,0 @@
-import * as React from 'react';
-
-import type { LocaleDirection } from './types';
-
-export const LocaleDirContext = React.createContext<LocaleDirection>('ltr');
-
-LocaleDirContext.displayName = 'LocaleDirContext';

package/src/NavigationContainer.tsx

@@ -1,211 +0,0 @@
-import {
-  BaseNavigationContainer,
-  getActionFromState,
-  getPathFromState,
-  getStateFromPath,
-  type NavigationContainerProps,
-  type NavigationContainerRef,
-  type NavigationState,
-  type ParamListBase,
-  ThemeProvider,
-  validatePathConfig,
-} from '@amazon-devices/react-navigation__core';
-import * as React from 'react';
-import { I18nManager } from 'react-native';
-import useLatestCallback from 'use-latest-callback';
-
-import { LinkingContext } from './LinkingContext';
-import { LocaleDirContext } from './LocaleDirContext';
-import { DefaultTheme } from './theming/DefaultTheme';
-import type {
-  DocumentTitleOptions,
-  LinkingOptions,
-  LocaleDirection,
-} from './types';
-import { UnhandledLinkingContext } from './UnhandledLinkingContext';
-import { useBackButton } from './useBackButton';
-import { useDocumentTitle } from './useDocumentTitle';
-import { useLinking } from './useLinking';
-import { useThenable } from './useThenable';
-
-declare global {
-  var REACT_NAVIGATION_DEVTOOLS: WeakMap<
-    NavigationContainerRef<any>,
-    { readonly linking: LinkingOptions<any> }
-  >;
-}
-
-globalThis.REACT_NAVIGATION_DEVTOOLS = new WeakMap();
-
-type Props<ParamList extends {}> = NavigationContainerProps & {
-  /**
-   * Initial state object for the navigation tree.
-   *
-   * If this is provided, deep link or URLs won't be handled on the initial render.
-   */
-  initialState?: NavigationContainerProps['initialState'];
-  /**
-   * Text direction of the components. Defaults to `'ltr'`.
-   */
-  direction?: LocaleDirection;
-  /**
-   * Options for deep linking.
-   *
-   * Deep link handling is enabled when this prop is provided,
-   * unless `linking.enabled` is `false`.
-   */
-  linking?: LinkingOptions<ParamList>;
-  /**
-   * Fallback element to render until initial state is resolved from deep linking.
-   *
-   * Defaults to `null`.
-   */
-  fallback?: React.ReactNode;
-  /**
-   * Options to configure the document title on Web.
-   *
-   * Updating document title is handled by default,
-   * unless `documentTitle.enabled` is `false`.
-   */
-  documentTitle?: DocumentTitleOptions;
-};
-
-function NavigationContainerInner(
-  {
-    direction = I18nManager.getConstants().isRTL ? 'rtl' : 'ltr',
-    theme = DefaultTheme,
-    linking,
-    fallback = null,
-    documentTitle,
-    onReady,
-    onStateChange,
-    ...rest
-  }: Props<ParamListBase>,
-  ref?: React.Ref<NavigationContainerRef<ParamListBase> | null>
-) {
-  const isLinkingEnabled = linking ? linking.enabled !== false : false;
-
-  if (linking?.config) {
-    validatePathConfig(linking.config);
-  }
-
-  const refContainer =
-    React.useRef<NavigationContainerRef<ParamListBase>>(null);
-
-  useBackButton(refContainer);
-  useDocumentTitle(refContainer, documentTitle);
-
-  const [lastUnhandledLink, setLastUnhandledLink] = React.useState<
-    string | undefined
-  >();
-
-  const { getInitialState } = useLinking(
-    refContainer,
-    {
-      enabled: isLinkingEnabled,
-      prefixes: [],
-      ...linking,
-    },
-    setLastUnhandledLink
-  );
-
-  const linkingContext = React.useMemo(() => ({ options: linking }), [linking]);
-
-  const unhandledLinkingContext = React.useMemo(
-    () => ({ lastUnhandledLink, setLastUnhandledLink }),
-    [lastUnhandledLink, setLastUnhandledLink]
-  );
-
-  const onReadyForLinkingHandling = useLatestCallback(() => {
-    // If the screen path matches lastUnhandledLink, we do not track it
-    const path = refContainer.current?.getCurrentRoute()?.path;
-    setLastUnhandledLink((previousLastUnhandledLink) => {
-      if (previousLastUnhandledLink === path) {
-        return undefined;
-      }
-      return previousLastUnhandledLink;
-    });
-    onReady?.();
-  });
-
-  const onStateChangeForLinkingHandling = useLatestCallback(
-    (state: Readonly<NavigationState> | undefined) => {
-      // If the screen path matches lastUnhandledLink, we do not track it
-      const path = refContainer.current?.getCurrentRoute()?.path;
-      setLastUnhandledLink((previousLastUnhandledLink) => {
-        if (previousLastUnhandledLink === path) {
-          return undefined;
-        }
-        return previousLastUnhandledLink;
-      });
-      onStateChange?.(state);
-    }
-  );
-  // Add additional linking related info to the ref
-  // This will be used by the devtools
-  React.useEffect(() => {
-    if (refContainer.current) {
-      REACT_NAVIGATION_DEVTOOLS.set(refContainer.current, {
-        get linking() {
-          return {
-            ...linking,
-            enabled: isLinkingEnabled,
-            prefixes: linking?.prefixes ?? [],
-            getStateFromPath: linking?.getStateFromPath ?? getStateFromPath,
-            getPathFromState: linking?.getPathFromState ?? getPathFromState,
-            getActionFromState:
-              linking?.getActionFromState ?? getActionFromState,
-          };
-        },
-      });
-    }
-  });
-
-  const [isResolved, initialState] = useThenable(getInitialState);
-
-  // FIXME
-  // @ts-expect-error not sure why this is not working
-  React.useImperativeHandle(ref, () => refContainer.current);
-
-  const isLinkingReady =
-    rest.initialState != null || !isLinkingEnabled || isResolved;
-
-  if (!isLinkingReady) {
-    return (
-      <LocaleDirContext.Provider value={direction}>
-        <ThemeProvider value={theme}>{fallback}</ThemeProvider>
-      </LocaleDirContext.Provider>
-    );
-  }
-
-  return (
-    <LocaleDirContext.Provider value={direction}>
-      <UnhandledLinkingContext.Provider value={unhandledLinkingContext}>
-        <LinkingContext.Provider value={linkingContext}>
-          <BaseNavigationContainer
-            {...rest}
-            theme={theme}
-            onReady={onReadyForLinkingHandling}
-            onStateChange={onStateChangeForLinkingHandling}
-            initialState={
-              rest.initialState == null ? initialState : rest.initialState
-            }
-            ref={refContainer}
-          />
-        </LinkingContext.Provider>
-      </UnhandledLinkingContext.Provider>
-    </LocaleDirContext.Provider>
-  );
-}
-
-/**
- * Container component that manages the navigation state.
- * This should be rendered at the root wrapping the whole app.
- */
-export const NavigationContainer = React.forwardRef(
-  NavigationContainerInner
-) as <RootParamList extends {} = ReactNavigation.RootParamList>(
-  props: Props<RootParamList> & {
-    ref?: React.Ref<NavigationContainerRef<RootParamList>>;
-  }
-) => React.ReactElement;

package/src/ServerContainer.tsx

@@ -1,57 +0,0 @@
-import { CurrentRenderContext } from '@amazon-devices/react-navigation__core';
-import * as React from 'react';
-
-import { ServerContext, type ServerContextType } from './ServerContext';
-import type { ServerContainerRef } from './types';
-
-type Props = ServerContextType & {
-  children: React.ReactNode;
-};
-
-/**
- * Container component for server rendering.
- *
- * @param props.location Location object to base the initial URL for SSR.
- * @param props.children Child elements to render the content.
- * @param props.ref Ref object which contains helper methods.
- */
-export const ServerContainer = React.forwardRef(function ServerContainer(
-  { children, location }: Props,
-  ref: React.Ref<ServerContainerRef>
-) {
-  React.useEffect(() => {
-    console.error(
-      "'ServerContainer' should only be used on the server with 'react-dom/server' for SSR."
-    );
-  }, []);
-
-  // eslint-disable-next-line @eslint-react/no-unstable-context-value
-  const current: { options?: object } = {};
-
-  if (ref) {
-    const value = {
-      getCurrentOptions() {
-        return current.options;
-      },
-    };
-
-    // We write to the `ref` during render instead of `React.useImperativeHandle`
-    // This is because `useImperativeHandle` will update the ref after 'commit',
-    // and there's no 'commit' phase during SSR.
-    // Mutating ref during render is unsafe in concurrent mode, but we don't care about it for SSR.
-    if (typeof ref === 'function') {
-      ref(value);
-    } else {
-      ref.current = value;
-    }
-  }
-
-  return (
-    // eslint-disable-next-line @eslint-react/no-unstable-context-value
-    <ServerContext.Provider value={{ location }}>
-      <CurrentRenderContext.Provider value={current}>
-        {children}
-      </CurrentRenderContext.Provider>
-    </ServerContext.Provider>
-  );
-});

package/src/ServerContext.tsx

@@ -1,12 +0,0 @@
-import * as React from 'react';
-
-export type ServerContextType = {
-  location?: {
-    pathname: string;
-    search: string;
-  };
-};
-
-export const ServerContext = React.createContext<ServerContextType | undefined>(
-  undefined
-);

package/src/UnhandledLinkingContext.tsx

@@ -1,18 +0,0 @@
-import * as React from 'react';
-
-const MISSING_CONTEXT_ERROR =
-  "Couldn't find an UnhandledLinkingContext context.";
-
-export const UnhandledLinkingContext = React.createContext<{
-  lastUnhandledLink: string | undefined;
-  setLastUnhandledLink: (lastUnhandledUrl: string | undefined) => void;
-}>({
-  get lastUnhandledLink(): any {
-    throw new Error(MISSING_CONTEXT_ERROR);
-  },
-  get setLastUnhandledLink(): any {
-    throw new Error(MISSING_CONTEXT_ERROR);
-  },
-});
-
-UnhandledLinkingContext.displayName = 'UnhandledLinkingContext';

package/src/__stubs__/createStackNavigator.tsx

@@ -1,46 +0,0 @@
-import {
-  createNavigatorFactory,
-  type DefaultNavigatorOptions,
-  type NavigationListBase,
-  type ParamListBase,
-  type StackNavigationState,
-  StackRouter,
-  type TypedNavigator,
-  useNavigationBuilder,
-} from '@amazon-devices/react-navigation__core';
-
-const StackNavigator = (
-  props: DefaultNavigatorOptions<
-    ParamListBase,
-    string | undefined,
-    StackNavigationState<ParamListBase>,
-    {},
-    {},
-    unknown
-  >
-) => {
-  const { state, descriptors, NavigationContent } = useNavigationBuilder(
-    StackRouter,
-    props
-  );
-
-  return (
-    <NavigationContent>
-      {descriptors[state.routes[state.index].key].render()}
-    </NavigationContent>
-  );
-};
-
-export function createStackNavigator<
-  ParamList extends ParamListBase,
->(): TypedNavigator<{
-  ParamList: ParamList;
-  NavigatorID: string | undefined;
-  State: StackNavigationState<ParamList>;
-  ScreenOptions: {};
-  EventMap: {};
-  NavigationList: NavigationListBase<ParamList>;
-  Navigator: typeof StackNavigator;
-}> {
-  return createNavigatorFactory(StackNavigator)();
-}

package/src/__stubs__/window.tsx

@@ -1,77 +0,0 @@
-let location = new URL('', 'http://example.com');
-
-let listeners: (() => void)[] = [];
-let entries = [{ state: null, href: location.href }];
-let index = 0;
-
-let currentState: any = null;
-
-const history = {
-  get state() {
-    return currentState;
-  },
-
-  pushState(state: any, _: string, path: string) {
-    location = new URL(path, location.origin);
-
-    currentState = state;
-    entries = entries.slice(0, index + 1);
-    entries.push({ state, href: location.href });
-    index = entries.length - 1;
-  },
-
-  replaceState(state: any, _: string, path: string) {
-    location = new URL(path, location.origin);
-
-    currentState = state;
-    entries[index] = { state, href: location.href };
-  },
-
-  go(n: number) {
-    setTimeout(() => {
-      if (
-        (n > 0 && n < entries.length - index) ||
-        (n < 0 && Math.abs(n) <= index)
-      ) {
-        index += n;
-        const entry = entries[index];
-        location = new URL(entry.href);
-        currentState = entry.state;
-        listeners.forEach((cb) => cb());
-      }
-    }, 0);
-  },
-
-  back() {
-    this.go(-1);
-  },
-
-  forward() {
-    this.go(1);
-  },
-};
-
-const addEventListener = (type: 'popstate', listener: () => void) => {
-  if (type === 'popstate') {
-    listeners.push(listener);
-  }
-};
-
-const removeEventListener = (type: 'popstate', listener: () => void) => {
-  if (type === 'popstate') {
-    listeners = listeners.filter((cb) => cb !== listener);
-  }
-};
-
-export const window = {
-  document: { title: '' },
-  get location() {
-    return location;
-  },
-  history,
-  addEventListener,
-  removeEventListener,
-  get window() {
-    return window;
-  },
-};