one 1.2.0 → 1.2.2

package/src/fork/_shared.ts

@@ -0,0 +1,22 @@
+/**
+ * Shared utilities for modifications in the fork.
+ */
+
+export const getParamName = (pattern: string) => pattern.replace(/^[:*]/, '').replace(/\?$/, '')
+
+export function getParamValue(p: string, value: string) {
+  if (p.startsWith('*')) {
+    const values = value.split('/').filter((v) => v !== '')
+    return values.length === 0 && p.endsWith('?') ? undefined : values
+  }
+
+  return value
+}
+
+export function isDynamicPart(p: string) {
+  return p.length > 1 && (p.startsWith(':') || p.startsWith('*'))
+}
+
+export function replacePart(p: string) {
+  return p.replace(/^[:*]/, '').replace(/\?$/, '')
+}

package/src/fork/createMemoryHistory.tsx

@@ -0,0 +1,236 @@
+/**
+ * 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'
+
+type HistoryRecord = {
+  // Unique identifier for this record to match it with window.history.state
+  id: string
+  // Navigation state object for the history entry
+  state: NavigationState
+  // Path of the history entry
+  path: string
+}
+
+export function createMemoryHistory() {
+  let index = 0
+  let items: HistoryRecord[] = []
+
+  // Pending callbacks for `history.go(n)`
+  // We might modify the callback stored if it was interrupted, so we have a ref to identify it
+  const pending: { ref: unknown; cb: (interrupted?: boolean) => void }[] = []
+
+  const interrupt = () => {
+    // If another history operation was performed we need to interrupt existing ones
+    // This makes sure that calls such as `history.replace` after `history.go` don't happen
+    // Since otherwise it won't be correct if something else has changed
+    pending.forEach((it) => {
+      const cb = it.cb
+      it.cb = () => cb(true)
+    })
+  }
+
+  const history = {
+    get index(): number {
+      // We store an id in the state instead of an index
+      // Index could get out of sync with in-memory values if page reloads
+      const id = window.history.state?.id
+
+      if (id) {
+        const index = items.findIndex((item) => item.id === id)
+
+        return index > -1 ? index : 0
+      }
+
+      return 0
+    },
+
+    get(index: number) {
+      return items[index]
+    },
+
+    backIndex({ path }: { path: string }) {
+      // We need to find the index from the element before current to get closest path to go back to
+      for (let i = index - 1; i >= 0; i--) {
+        const item = items[i]
+
+        if (item.path === path) {
+          return i
+        }
+      }
+
+      return -1
+    },
+
+    push({ path, state }: { path: string; state: NavigationState }) {
+      interrupt()
+
+      const id = nanoid()
+
+      // When a new entry is pushed, all the existing entries after index will be inaccessible
+      // So we remove any existing entries after the current index to clean them up
+      items = items.slice(0, index + 1)
+
+      items.push({ path, state, id })
+      index = items.length - 1
+
+      // We pass empty string for title because it's ignored in all browsers except safari
+      // We don't store state object in history.state because:
+      // - browsers have limits on how big it can be, and we don't control the size
+      // - while not recommended, there could be non-serializable data in state
+      window.history.pushState({ id }, '', path)
+    },
+
+    replace({ path, state }: { path: string; state: NavigationState }) {
+      interrupt()
+
+      const id = window.history.state?.id ?? nanoid()
+
+      // 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
+      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:
+        // - When loaded id not found in the items array, this function by default will replace
+        //   the first item. We need to keep only the new updated object, otherwise it will break
+        //   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 + hash
+        items = [{ path: pathWithHash, state, id }]
+        index = 0
+      } else {
+        if (items[index].path === path) {
+          pathWithHash = pathWithHash + hash
+        }
+        items[index] = { path, state, id }
+      }
+
+      window.history.replaceState({ id }, '', pathWithHash)
+    },
+
+    // `history.go(n)` is asynchronous, there are couple of things to keep in mind:
+    // - it won't do anything if we can't go `n` steps, the `popstate` event won't fire.
+    // - each `history.go(n)` call will trigger a separate `popstate` event with correct location.
+    // - the `popstate` event fires before the next frame after calling `history.go(n)`.
+    // This method differs from `history.go(n)` in the sense that it'll go back as many steps it can.
+    go(n: number) {
+      interrupt()
+
+      // To guard against unexpected navigation out of the app we will assume that browser history is only as deep as the length of our memory
+      // history. If we don't have an item to navigate to then update our index and navigate as far as we can without taking the user out of the app.
+      const nextIndex = index + n
+      const lastItemIndex = items.length - 1
+      if (n < 0 && !items[nextIndex]) {
+        // Attempted to navigate beyond the first index. Negating the current index will align the browser history with the first item.
+        n = -index
+        index = 0
+      } else if (n > 0 && nextIndex > lastItemIndex) {
+        // Attempted to navigate past the last index. Calculate how many indices away from the last index and go there.
+        n = lastItemIndex - index
+        index = lastItemIndex
+      } else {
+        index = nextIndex
+      }
+
+      if (n === 0) {
+        return
+      }
+
+      // When we call `history.go`, `popstate` will fire when there's history to go back to
+      // So we need to somehow handle following cases:
+      // - There's history to go back, `history.go` is called, and `popstate` fires
+      // - `history.go` is called multiple times, we need to resolve on respective `popstate`
+      // - No history to go back, but `history.go` was called, browser has no API to detect it
+      return new Promise<void>((resolve, reject) => {
+        const done = (interrupted?: boolean) => {
+          clearTimeout(timer)
+
+          if (interrupted) {
+            reject(new Error('History was changed during navigation.'))
+            return
+          }
+
+          // There seems to be a bug in Chrome regarding updating the title
+          // If we set a title just before calling `history.go`, the title gets lost
+          // However the value of `document.title` is still what we set it to
+          // It's just not displayed in the tab bar
+          // To update the tab bar, we need to reset the title to something else first (e.g. '')
+          // And set the title to what it was before so it gets applied
+          // It won't work without setting it to empty string coz otherwise title isn't changing
+          // Which means that the browser won't do anything after setting the title
+          const { title } = window.document
+
+          window.document.title = ''
+          window.document.title = title
+
+          resolve()
+        }
+
+        pending.push({ ref: done, cb: done })
+
+        // If navigation didn't happen within 100ms, assume that it won't happen
+        // This may not be accurate, but hopefully it won't take so much time
+        // In Chrome, navigation seems to happen instantly in next microtask
+        // But on Firefox, it seems to take much longer, around 50ms from our testing
+        // We're using a hacky timeout since there doesn't seem to be way to know for sure
+        const timer = setTimeout(() => {
+          const index = pending.findIndex((it) => it.ref === done)
+
+          if (index > -1) {
+            pending[index].cb()
+            pending.splice(index, 1)
+          }
+        }, 100)
+
+        const onPopState = () => {
+          const id = window.history.state?.id
+          const currentIndex = items.findIndex((item) => item.id === id)
+
+          // Fix createMemoryHistory.index variable's value
+          // as it may go out of sync when navigating in the browser.
+          index = Math.max(currentIndex, 0)
+
+          const last = pending.pop()
+
+          window.removeEventListener('popstate', onPopState)
+          last?.cb()
+        }
+
+        window.addEventListener('popstate', onPopState)
+        window.history.go(n)
+      })
+    },
+
+    // The `popstate` event is triggered when history changes, except `pushState` and `replaceState`
+    // If we call `history.go(n)` ourselves, we don't want it to trigger the listener
+    // Here we normalize it so that only external changes (e.g. user pressing back/forward) trigger the listener
+    listen(listener: () => void) {
+      const onPopState = () => {
+        if (pending.length) {
+          // This was triggered by `history.go(n)`, we shouldn't call the listener
+          return
+        }
+
+        listener()
+      }
+
+      window.addEventListener('popstate', onPopState)
+
+      return () => window.removeEventListener('popstate', onPopState)
+    },
+  }
+
+  return history
+}

package/src/fork/extractPathFromURL.ts

@@ -0,0 +1,140 @@
+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 {
+  if (
+    // If a universal link / app link / web URL is used, we should use the path
+    // from the URL, while stripping the origin.
+    url.match(/^https?:\/\//)
+  ) {
+    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 globalThis.expo !== 'undefined' && globalThis.expo?.modules?.ExpoGo
+
+  // Handle special URLs used in Expo Go: `/--/pathname` -> `pathname`
+  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
+
+  return fromDeepLink(url)
+}
+
+/** Major hack to support the makeshift expo-development-client system. */
+function isExpoDevelopmentClient(url: URL): boolean {
+  return url.hostname === 'expo-development-client'
+}
+
+function fromDeepLink(url: string): string {
+  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.searchParams.get('url')) {
+      return ''
+    }
+    const incomingUrl = res.searchParams.get('url')!
+    return extractExactPathFromURL(decodeURI(incomingUrl))
+  }
+
+  let results = ''
+
+  if (res.host) {
+    results += res.host
+  }
+
+  if (res.pathname) {
+    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
+  }
+
+  return results
+}
+
+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 }) {
+  if (url.hostname === 'exp.host' || url.hostname === 'u.expo.dev') {
+    // drop the first two segments from pathname:
+    return url.pathname.split('/').slice(2).join('/')
+  }
+  return url.pathname
+}
+
+export const extractPathFromURL = extractExpoPathFromURL

package/src/fork/findFocusedRoute.tsx

@@ -0,0 +1,23 @@
+/**
+ * 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'
+
+export function findFocusedRoute(state: InitialState) {
+  let current: InitialState | undefined = state
+
+  while (current?.routes[current.index ?? 0].state != null) {
+    current = current.routes[current.index ?? 0].state
+  }
+
+  const route = current?.routes[current?.index ?? 0]
+
+  return route
+}

package/src/fork/getPathFromState-mods.ts

@@ -0,0 +1,157 @@
+/**
+ * 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'
+import { getParamName } from './_shared'
+
+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)
+
+      // We don't know what to show for wildcard patterns
+      // 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 (i === 0) {
+          // This can occur when a wildcard matches all routes and the given path was `/`.
+          return route
+        }
+
+        if (p === '*not-found') {
+          return ''
+        }
+        // remove existing segments from route.path and return it
+        // this is used for nested wildcard routes. Without this, the path would add
+        // all nested segments to the beginning of the wildcard route.
+        return route.name
+          ?.split('/')
+          .slice(i + 1)
+          .join('/')
+      }
+
+      // 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 undefined
+        }
+
+        // return params[name]
+        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
+              ? encodeURIComponentPreservingBrackets(initialRouteName)
+              : initialRouteName
+          }
+        }
+        return ''
+      }
+
+      return shouldEncodeURISegment ? encodeURIComponentPreservingBrackets(p) : p
+    })
+    .map((v) => v ?? '')
+    .join('/')
+}
+
+function encodeURIComponentPreservingBrackets(str: string) {
+  return encodeURIComponent(str).replace(/%5B/g, '[').replace(/%5D/g, ']')
+}
+
+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
+}