one 1.1.390 → 1.1.391

package/src/fork/NavigationContainer.tsx

@@ -1,40 +1,63 @@
-// Forked from React Navigation
+/**
+ * This file is copied from the react-navigation repo:
+ * https://github.com/react-navigation/react-navigation/blob/%40react-navigation/core%407.1.2/packages/core/src/getPathFromState.tsx
+ *
+ * Please refrain from making changes to this file, as it will make merging updates from the upstream harder.
+ * All modifications except formatting should be marked with `// @modified` comment.
+ */
 
 import {
   BaseNavigationContainer,
-  DefaultTheme,
-  type DocumentTitleOptions,
-  LinkingContext,
-  type LinkingOptions,
-  LocaleDirContext,
-  type LocaleDirection,
+  getActionFromState,
+  getPathFromState,
+  getStateFromPath,
   type NavigationContainerProps,
   type NavigationContainerRef,
+  type NavigationState,
   type ParamListBase,
-  type Theme,
   ThemeProvider,
-  getActionFromState,
-  getPathFromState,
-  getStateFromPath,
   validatePathConfig,
-} from '@react-navigation/native'
+} from '@react-navigation/core'
 import * as React from 'react'
-
-import useLinking from './useLinking'
 import { I18nManager } from 'react-native'
+import useLatestCallback from 'use-latest-callback'
+
+// @modified - start
+// 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 {
+  LinkingContext,
+  LocaleDirContext,
+  DefaultTheme,
+  type DocumentTitleOptions,
+  type LinkingOptions,
+  type LocaleDirection,
+  UNSTABLE_UnhandledLinkingContext as UnhandledLinkingContext,
+} from '@react-navigation/native'
+// @modified - end
 import { useBackButton } from './useBackButton'
 import { useDocumentTitle } from './useDocumentTitle'
+import { useLinking } from './useLinking'
 import { useThenable } from './useThenable'
 
+declare global {
+  // eslint-disable-next-line no-var
+  var REACT_NAVIGATION_DEVTOOLS: WeakMap<
+    NavigationContainerRef<any>,
+    { readonly linking: LinkingOptions<any> }
+  >
+}
+
 globalThis.REACT_NAVIGATION_DEVTOOLS = new WeakMap()
 
-type Props<ParamList extends object> = NavigationContainerProps & {
+type Props<ParamList extends {}> = NavigationContainerProps & {
   direction?: LocaleDirection
-  documentTitle?: DocumentTitleOptions
-  fallback?: React.ReactNode
   linking?: LinkingOptions<ParamList>
-  onReady?: () => void
-  theme?: Theme
+  fallback?: React.ReactNode
+  documentTitle?: DocumentTitleOptions
 }
 
 /**
@@ -44,7 +67,9 @@ type Props<ParamList extends object> = NavigationContainerProps & {
  * @param props.initialState Initial state object for the navigation tree. When deep link handling is enabled, this will override deep links when specified. Make sure that you don't specify an `initialState` when there's a deep link (`Linking.getInitialURL()`).
  * @param props.onReady Callback which is called after the navigation tree mounts.
  * @param props.onStateChange Callback which is called with the latest navigation state when it changes.
- * @param props.theme Theme object for the navigators.
+ * @param props.onUnhandledAction Callback which is called when an action is not handled.
+ * @param props.direction Text direction of the components. Defaults to `'ltr'`.
+ * @param props.theme Theme object for the UI elements.
  * @param props.linking Options for deep linking. Deep link handling is enabled when this prop is provided, unless `linking.enabled` is `false`.
  * @param props.fallback Fallback component to render until we have finished getting initial state when linking is enabled. Defaults to `null`.
  * @param props.documentTitle Options to configure the document title on Web. Updating document title is handled by default unless `documentTitle.enabled` is `false`.
@@ -59,6 +84,7 @@ function NavigationContainerInner(
     fallback = null,
     documentTitle,
     onReady,
+    onStateChange,
     ...rest
   }: Props<ParamListBase>,
   ref?: React.Ref<NavigationContainerRef<ParamListBase> | null>
@@ -74,12 +100,50 @@ function NavigationContainerInner(
   useBackButton(refContainer)
   useDocumentTitle(refContainer, documentTitle)
 
-  const { getInitialState } = useLinking(refContainer, {
-    enabled: isLinkingEnabled,
-    prefixes: [],
-    ...linking,
+  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(() => {
@@ -103,38 +167,36 @@ function NavigationContainerInner(
 
   React.useImperativeHandle(ref, () => refContainer.current)
 
-  const linkingContext = React.useMemo(() => ({ options: linking }), [linking])
+  const isLinkingReady = rest.initialState != null || !isLinkingEnabled || isResolved
 
-  React.useEffect(() => {
-    onReady?.()
-  }, [onReady])
-
-  if (!isResolved) {
+  if (!isLinkingReady) {
+    // This is temporary until we have Suspense for data-fetching
+    // Then the fallback will be handled by a parent `Suspense` component
     return <ThemeProvider value={theme}>{fallback}</ThemeProvider>
   }
 
   return (
     <LocaleDirContext.Provider value={direction}>
-      <LinkingContext.Provider value={linkingContext}>
-        <ThemeProvider value={theme}>
+      <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}
-            initialState={initialState ?? rest.initialState}
           />
-        </ThemeProvider>
-      </LinkingContext.Provider>
+        </LinkingContext.Provider>
+      </UnhandledLinkingContext.Provider>
     </LocaleDirContext.Provider>
   )
 }
 
-const NavigationContainer = React.forwardRef(NavigationContainerInner) as <
-  RootParamList extends object = ReactNavigation.RootParamList,
+export const NavigationContainer = React.forwardRef(NavigationContainerInner) as <
+  RootParamList extends {} = ReactNavigation.RootParamList
 >(
   props: Props<RootParamList> & {
     ref?: React.Ref<NavigationContainerRef<RootParamList>>
   }
 ) => React.ReactElement
-
-export default NavigationContainer

package/src/fork/createMemoryHistory.tsx

@@ -1,10 +1,16 @@
+/**
+ * This file is copied from the react-navigation repo:
+ * https://github.com/react-navigation/react-navigation/blob/%40react-navigation/core%407.1.2/packages/native/src/createMemoryHistory.tsx
+ *
+ * Please refrain from making changes to this file, as it will make merging updates from the upstream harder.
+ * All modifications except formatting should be marked with `// @modified` comment.
+ *
+ * No modifications currently, copied only in order to use a custom `useLinking` function.
+ */
+
 import type { NavigationState } from '@react-navigation/core'
 import { nanoid } from 'nanoid/non-secure'
 
-// forked from @react-navigation/native/src/createMemoryHistory.tsx
-// NOTE there was a change we made for search params, but we've fixed it upstream
-// we can revert this back to the react-navigation one if we want
-
 type HistoryRecord = {
   // Unique identifier for this record to match it with window.history.state
   id: string
@@ -14,7 +20,7 @@ type HistoryRecord = {
   path: string
 }
 
-export default function createMemoryHistory() {
+export function createMemoryHistory() {
   let index = 0
   let items: HistoryRecord[] = []
 
@@ -91,12 +97,7 @@ export default function createMemoryHistory() {
       // Need to keep the hash part of the path if there was no previous history entry
       // or the previous history entry had the same path
       let pathWithHash = path
-
-      // NOTE: this was the wrong fix
-      // if (window.location.search) {
-      //   console.log('replacing!')
-      //   pathWithHash = pathWithHash + window.location.search
-      // }
+      const hash = pathWithHash.includes('#') ? '' : location.hash
 
       if (!items.length || items.findIndex((item) => item.id === id) < 0) {
         // There are two scenarios for creating an array with only one history record:
@@ -105,12 +106,13 @@ export default function createMemoryHistory() {
         //   the page when navigating forward in history.
         // - This is the first time any state modifications are done
         //   So we need to push the entry as there's nothing to replace
-        pathWithHash = pathWithHash + location.hash
+
+        pathWithHash = pathWithHash + hash
         items = [{ path: pathWithHash, state, id }]
         index = 0
       } else {
         if (items[index].path === path) {
-          pathWithHash = pathWithHash + location.hash
+          pathWithHash = pathWithHash + hash
         }
         items[index] = { path, state, id }
       }

package/src/fork/extractPathFromURL.ts

@@ -1,4 +1,23 @@
-import URL from 'url-parse'
+export function parsePathAndParamsFromExpoGoLink(url: string): {
+  pathname: string
+  queryString: string
+} {
+  // If the URL is defined (default in Expo Go dev apps) and the URL has no path:
+  // `exp://192.168.87.39:19000/` then use the default `exp://192.168.87.39:19000/--/`
+
+  const href = parsePathFromExpoGoLink(url)
+  const results = href.match(/([^?]*)(\?.*)?/)
+  return {
+    pathname: results?.[1] ?? '',
+    queryString: results?.[2] ?? '',
+  }
+}
+
+export function parsePathFromExpoGoLink(url: string): string {
+  // If the URL is defined (default in Expo Go dev apps) and the URL has no path:
+  // `exp://192.168.87.39:19000/` then use the default `exp://192.168.87.39:19000/--/`
+  return url.match(/exps?:\/\/.*?\/--\/(.*)/)?.[1] ?? ''
+}
 
 // This is only run on native.
 function extractExactPathFromURL(url: string): string {
@@ -7,33 +26,38 @@ function extractExactPathFromURL(url: string): string {
     // from the URL, while stripping the origin.
     url.match(/^https?:\/\//)
   ) {
-    const { origin, href } = new URL(url)
+    const { origin, href, hostname } = new URL(url)
+
+    if (hostname === 'exp.host' || hostname === 'u.expo.dev') {
+      // These are QR code generate deep-link that always like to the '/' path
+      // TODO: In the future, QR code may link to a specific path and this logic will need to be udpated
+      return ''
+    }
+
     return href.replace(origin, '')
   }
 
+  const isExpoGo = typeof expo !== 'undefined' && globalThis.expo?.modules?.ExpoGo
+
   // Handle special URLs used in Expo Go: `/--/pathname` -> `pathname`
-  // if (
-  //   Constants.executionEnvironment === ExecutionEnvironment.StoreClient &&
-  //   // while not exhaustive, `exp` and `exps` are the only two schemes which
-  //   // are passed through to other apps in Expo Go.
-  //   url.match(/^exp(s)?:\/\//)
-  // ) {
-  //   const pathname = url.match(/exps?:\/\/.*?\/--\/(.*)/)?.[1]
-  //   if (pathname) {
-  //     return fromDeepLink('a://' + pathname)
-  //   }
-
-  //   const res = Linking.parse(url)
-
-  //   const qs = !res.queryParams
-  //     ? ''
-  //     : Object.entries(res.queryParams)
-  //         .map(([k, v]) => `${k}=${v}`)
-  //         .join('&')
-  //   return (
-  //     adjustPathname({ hostname: res.hostname, pathname: res.path || '' }) + (qs ? '?' + qs : '')
-  //   )
-  // }
+  if (
+    isExpoGo &&
+    // while not exhaustive, `exp` and `exps` are the only two schemes which
+    // are passed through to other apps in Expo Go.
+    url.match(/^exp(s)?:\/\//)
+  ) {
+    const pathname = parsePathFromExpoGoLink(url)
+    if (pathname) {
+      return fromDeepLink('a://' + pathname)
+    }
+    // Match the `?.*` segment of the URL.
+    const queryParams = url.match(/exps?:\/\/.*\?(.*)/)?.[1]
+    if (queryParams) {
+      return fromDeepLink('a://?' + queryParams)
+    }
+
+    return ''
+  }
 
   // TODO: Support dev client URLs
 
@@ -41,29 +65,38 @@ function extractExactPathFromURL(url: string): string {
 }
 
 /** Major hack to support the makeshift expo-development-client system. */
-function isExpoDevelopmentClient(url: URL<Record<string, string | undefined>>): boolean {
-  return !!url.hostname.match(/^expo-development-client$/)
+function isExpoDevelopmentClient(url: URL): boolean {
+  return url.hostname === 'expo-development-client'
 }
 
 function fromDeepLink(url: string): string {
-  // This is for all standard deep links, e.g. `foobar://` where everything
-  // after the `://` is the path.
-  const res = new URL(url, true)
+  let res: URL | null
+  try {
+    // This is for all standard deep links, e.g. `foobar://` where everything
+    // after the `://` is the path.
+    res = new URL(url)
+  } catch {
+    /**
+     * We failed to parse the URL. This can occur for a variety of reasons, including:
+     * - Its a partial URL (e.g. `/route?query=param`).
+     * - It has a valid App scheme, but the scheme isn't a valid URL scheme (e.g. `my_app://`)
+     */
+
+    /**
+     * App schemes are not valid URL schemes, so they will fail to parse.
+     * We need to strip the scheme from these URLs
+     */
+    return url.replace(/^[^:]+:\/\//, '')
+  }
 
   if (isExpoDevelopmentClient(res)) {
-    if (!res.query || !res.query.url) {
+    if (!res.searchParams.get('url')) {
       return ''
     }
-    const incomingUrl = res.query.url
+    const incomingUrl = res.searchParams.get('url')!
     return extractExactPathFromURL(decodeURI(incomingUrl))
   }
 
-  const qs = !res.query
-    ? ''
-    : Object.entries(res.query as Record<string, string>)
-        .map(([k, v]) => `${k}=${decodeURIComponent(v)}`)
-        .join('&')
-
   let results = ''
 
   if (res.host) {
@@ -74,6 +107,13 @@ function fromDeepLink(url: string): string {
     results += res.pathname
   }
 
+  const qs = !res.search
+    ? ''
+    : // @ts-ignore: `entries` is not on `URLSearchParams` in some typechecks.
+      [...res.searchParams.entries()]
+        .map(([k, v]) => `${k}=${decodeURIComponent(v)}`)
+        .join('&')
+
   if (qs) {
     results += '?' + qs
   }
@@ -81,9 +121,12 @@ function fromDeepLink(url: string): string {
   return results
 }
 
-export function extractExpoPathFromURL(url = '') {
-  // TODO: We should get rid of this, dropping specificities is not good
-  return extractExactPathFromURL(url).replace(/^\//, '')
+export function extractExpoPathFromURL(_prefixes: string[], url = '') {
+  return (
+    extractExactPathFromURL(url)
+      // TODO: We should get rid of this, dropping specificities is not good
+      .replace(/^\//, '')
+  )
 }
 
 export function adjustPathname(url: { hostname?: string | null; pathname: string }) {
@@ -93,3 +136,5 @@ export function adjustPathname(url: { hostname?: string | null; pathname: string
   }
   return url.pathname
 }
+
+export const extractPathFromURL = extractExpoPathFromURL

package/src/fork/findFocusedRoute.tsx

@@ -1,4 +1,12 @@
-// Forked so we can access without importing any React Native code in Node.js environments.
+/**
+ * This file is copied from the react-navigation repo:
+ * https://github.com/react-navigation/react-navigation/blob/%40react-navigation/core%407.1.2/packages/core/src/findFocusedRoute.tsx
+ *
+ * Please refrain from making changes to this file, as it will make merging updates from the upstream harder.
+ * All modifications except formatting should be marked with `// @modified` comment.
+ *
+ * No modifications currently, copied so we can access without importing any React Native code in Node.js environments.
+ */
 
 import type { InitialState } from '@react-navigation/routers'
 

package/src/fork/getPathFromState-mods.ts

@@ -0,0 +1,142 @@
+/**
+ * This file exports things that will be used to modify the forked code in `getPathFromState.ts`.
+ *
+ * The purpose of keeping things in this separated file is to keep changes to the copied code as little as possible, making merging upstream updates easier.
+ */
+
+import type { Route } from '@react-navigation/core'
+
+import { matchDeepDynamicRouteName, matchDynamicName, matchGroupName } from '../router/matchers'
+
+export type AdditionalOptions = {
+  preserveDynamicRoutes?: boolean
+  preserveGroups?: boolean
+  shouldEncodeURISegment?: boolean
+}
+
+export type ConfigItemMods = {
+  // Used as fallback for groups
+  initialRouteName?: string
+}
+
+export function getPathWithConventionsCollapsed({
+  pattern,
+  route,
+  params,
+  preserveGroups,
+  preserveDynamicRoutes,
+  shouldEncodeURISegment = true,
+  initialRouteName,
+}: AdditionalOptions & {
+  pattern: string
+  route: Route<any>
+  params: Record<string, any>
+  initialRouteName?: string
+}) {
+  const segments = pattern.split('/');
+
+  return segments
+    .map((p, i) => {
+      const name = getParamName(p)
+
+      // Showing the route name seems ok, though whatever we show here will be incorrect
+      // Since the page doesn't actually exist
+      if (p.startsWith('*')) {
+        if (preserveDynamicRoutes) {
+          if (name === 'not-found') {
+            return '+not-found'
+          }
+
+          return `[...${name}]`
+        }
+
+        if (params[name]) {
+          if (Array.isArray(params[name])) {
+            return params[name].join('/')
+          }
+          return params[name]
+        }
+
+        if (route.name.startsWith('[') && route.name.endsWith(']')) {
+          return ''
+        }
+
+        if (p === '*not-found') {
+          return ''
+        }
+
+        return route.name
+      }
+
+      // If the path has a pattern for a param, put the param in the path
+      if (p.startsWith(':')) {
+        if (preserveDynamicRoutes) {
+          return `[${name}]`
+        }
+        // Optional params without value assigned in route.params should be ignored
+        const value = params[name]
+        if (value === undefined && p.endsWith('?')) {
+          return
+        }
+
+        return (shouldEncodeURISegment ? encodeURISegment(value) : value) ?? 'undefined'
+      }
+
+      if (!preserveGroups && matchGroupName(p) != null) {
+        // When the last part is a group it could be a shared URL
+        // if the route has an initialRouteName defined, then we should
+        // use that as the component path as we can assume it will be shown.
+        if (segments.length - 1 === i) {
+          if (initialRouteName) {
+            // Return an empty string if the init route is ambiguous.
+            if (segmentMatchesConvention(initialRouteName)) {
+              return ''
+            }
+            return shouldEncodeURISegment
+              ? encodeURISegment(initialRouteName, { preserveBrackets: true })
+              : initialRouteName
+          }
+        }
+        return ''
+      }
+      // Preserve dynamic syntax for rehydration
+      return shouldEncodeURISegment ? encodeURISegment(p, { preserveBrackets: true }) : p
+    })
+    .map((v) => v ?? '')
+    .join('/')
+}
+
+export const getParamName = (pattern: string) => pattern.replace(/^[:*]/, '').replace(/\?$/, '')
+
+export function appendBaseUrl(
+  path: string,
+  baseUrl: string | undefined = process.env.EXPO_BASE_URL
+) {
+  if (process.env.NODE_ENV !== 'development') {
+    if (baseUrl) {
+      return `/${baseUrl.replace(/^\/+/, '').replace(/\/$/, '')}${path}`
+    }
+  }
+  return path
+}
+
+function segmentMatchesConvention(segment: string): boolean {
+  return (
+    segment === 'index' ||
+    matchDynamicName(segment) != null ||
+    matchGroupName(segment) != null ||
+    matchDeepDynamicRouteName(segment) != null
+  )
+}
+
+function encodeURISegment(str: string, { preserveBrackets = false } = {}) {
+  // Valid characters according to
+  // https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 (see pchar definition)
+  str = String(str).replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]/g, (char) => encodeURIComponent(char))
+
+  if (preserveBrackets) {
+    // Preserve brackets
+    str = str.replace(/%5B/g, '[').replace(/%5D/g, ']')
+  }
+  return str
+}