@react-navigation/core 8.0.0-alpha.4 → 8.0.0-alpha.41

package/src/getStateFromPath.tsx

@@ -1,33 +1,52 @@
-import type {
-  InitialState,
-  NavigationState,
-  PartialState,
-} from '@react-navigation/routers';
-import escape from 'escape-string-regexp';
-import * as queryString from 'query-string';
+import type { NavigationState, PartialState } from '@react-navigation/routers';
 
 import { arrayStartsWith } from './arrayStartsWith';
-import { findFocusedRoute } from './findFocusedRoute';
-import { getPatternParts, type PatternPart } from './getPatternParts';
+import {
+  combinePatternParts,
+  getPatternParts,
+  type PatternPartRepeat,
+} from './getPatternParts';
 import { isArrayEqual } from './isArrayEqual';
+import * as queryString from './queryString';
 import type { PathConfig, PathConfigMap } from './types';
+import type {
+  StandardSchemaV1,
+  StandardSchemaValidationResult,
+} from './utilities';
 import { validatePathConfig } from './validatePathConfig';
 
 type Options<ParamList extends {}> = {
-  path?: string;
-  initialRouteName?: string;
+  path?: string | undefined;
+  initialRouteName?: string | undefined;
   screens: PathConfigMap<ParamList>;
 };
 
-type ParseConfig = Record<string, ((value: string) => unknown) | undefined>;
+type ParseConfigValue =
+  | ((value: string) => unknown)
+  | StandardSchemaV1<unknown, unknown>;
+
+type ParseConfig = Record<string, ParseConfigValue | undefined>;
 
 type RouteConfig = {
   screen: string;
-  regex?: RegExp;
+  order: number;
+  regex?: RegExp | undefined;
+  pattern: string;
   segments: string[];
-  params: { screen: string; name?: string; index: number }[];
+  segmentRanks: number[];
+  params: {
+    screen: string;
+    name: string;
+    index: number;
+    regex?: RegExp | undefined;
+    repeat?: PatternPartRepeat;
+  }[];
   routeNames: string[];
-  parse?: ParseConfig;
+  parse?: ParseConfig | undefined;
+  explicitParamNames?: Set<string> | undefined;
+  pathParamNames: Set<string>;
+  hasNestedScreens: boolean;
+  shared: boolean;
 };
 
 type InitialRouteConfig = {
@@ -35,19 +54,144 @@ type InitialRouteConfig = {
   parentScreens: string[];
 };
 
-type ResultState = PartialState<NavigationState> & {
-  state?: ResultState;
-};
-
 type ParsedRoute = {
   name: string;
-  path?: string;
   params?: Record<string, unknown> | undefined;
+  path?: string | undefined;
 };
 
+type RoutePatternPart =
+  | {
+      type: 'static';
+      segment: string;
+      rank: number;
+      pattern: string;
+    }
+  | {
+      type: 'param';
+      screen: string;
+      segment: string;
+      rank: number;
+      name: string;
+      pattern?: string;
+      regex?: RegExp;
+      optional?: boolean;
+      repeat?: PatternPartRepeat;
+    }
+  | {
+      type: 'wildcard';
+      segment: '*';
+      rank: number;
+    };
+
 type ConfigResources = {
   initialRoutes: InitialRouteConfig[];
   configs: RouteConfig[];
+  configsWithZeroOrMore: RouteConfig[];
+  configsByScreen: Record<string, RouteConfig[]>;
+  configsByPattern: Record<string, RouteConfig[]>;
+  prefixRegex?: RegExp | undefined;
+};
+
+const INVALID_SCHEMA_RESULT_ERROR =
+  'Invalid validation result from schema. It should be an object with either "value" or "issues" property and cannot be asynchronous.';
+
+const INVALID_PARSER_ERROR =
+  'Invalid parser. Expected a function or a Standard Schema V1 object.';
+
+const PARAM_GROUP_PREFIX = 'param_';
+
+const NESTED_SCREEN_PARAM_NAMES = [
+  'screen',
+  'params',
+  'initial',
+  'path',
+  'merge',
+  'pop',
+];
+
+const REGEX_SYNTAX_CHAR = /[|\\{}()[\]^$+*?.]/;
+const HEX_DIGITS = '0123456789ABCDEF';
+
+const getStaticSegmentPattern = (segment: string) => {
+  let pattern = '';
+
+  for (const char of segment) {
+    const code = char.charCodeAt(0);
+
+    let escaped = char;
+
+    // A hyphen uses a hexadecimal escape because a regular backslash escape
+    // isn't valid outside character classes when a regex uses Unicode mode.
+    if (char === '-') {
+      escaped = '\\x2d';
+    } else {
+      // Other characters with special meaning in a regex can use a regular
+      // backslash escape so they are matched as literal characters.
+      if (REGEX_SYNTAX_CHAR.test(char)) {
+        escaped = `\\${char}`;
+      }
+    }
+
+    // ASCII characters have a single-byte percent-encoded form that can be
+    // built directly. Other characters need encodeURIComponent to encode all
+    // bytes in their UTF-8 representation.
+    const percentEncoded =
+      char.length === 1 && code < 128
+        ? `%${HEX_DIGITS.charAt(code >> 4)}${HEX_DIGITS.charAt(code & 15)}`
+        : encodeURIComponent(char);
+
+    pattern += `(?:${escaped}|${percentEncoded})`;
+  }
+
+  return pattern;
+};
+
+const getExplicitParamNames = (parse?: ParseConfig) => {
+  const names: string[] = [];
+
+  if (parse) {
+    for (const name in parse) {
+      if (parse[name] != null) {
+        names.push(name);
+      }
+    }
+  }
+
+  return names.length ? new Set(names) : undefined;
+};
+
+const getStandardSchema = (parser: ParseConfigValue) => {
+  if (
+    '~standard' in parser &&
+    typeof parser['~standard'] === 'object' &&
+    parser['~standard'] !== null &&
+    'version' in parser['~standard'] &&
+    parser['~standard'].version === 1 &&
+    'validate' in parser['~standard'] &&
+    typeof parser['~standard'].validate === 'function'
+  ) {
+    return parser['~standard'];
+  }
+
+  return undefined;
+};
+
+const getValidationResult = (
+  schema: StandardSchemaV1<unknown, unknown>['~standard'],
+  value: unknown
+): StandardSchemaValidationResult<unknown> => {
+  const result = schema.validate(value);
+
+  if (
+    result != null &&
+    typeof result === 'object' &&
+    ('value' in result || ('issues' in result && Array.isArray(result.issues)))
+  ) {
+    return result;
+  }
+
+  throw new Error(INVALID_SCHEMA_RESULT_ERROR);
 };
 
 /**
@@ -73,44 +217,68 @@ type ConfigResources = {
  */
 export function getStateFromPath<ParamList extends {}>(
   path: string,
-  options?: Options<ParamList>
-): ResultState | undefined {
-  const { initialRoutes, configs } = getConfigResources(options);
+  options?: Options<ParamList>,
+  previous?: NavigationState
+): PartialState<NavigationState> | undefined {
+  const {
+    initialRoutes,
+    configs,
+    configsWithZeroOrMore,
+    configsByScreen,
+    configsByPattern,
+    prefixRegex,
+  } = getConfigResources(options);
 
   const screens = options?.screens;
 
+  // When a matched config is shared, the same pattern can resolve to multiple branches
+  // pick the one that best matches the current navigation state
+  const resolveSharedConfig = (config: RouteConfig) => {
+    if (config.shared) {
+      const candidates = configsByPattern[config.pattern];
+
+      if (candidates) {
+        return selectSharedConfig(config, candidates, previous, initialRoutes);
+      }
+    }
+
+    return config;
+  };
+
   let remaining = path
     .replace(/\/+/g, '/') // Replace multiple slash (//) with single ones
     .replace(/^\//, '') // Remove extra leading slash
-    .replace(/\?.*$/, ''); // Remove query params which we will handle later
+    .replace(/\?.*$/, '') // Remove query params which we will handle later
+    .replace(/%[0-9a-f]{2}/gi, (m) => m.toUpperCase()); // Normalize percent-encoding as hex digits are case-insensitive
 
   // Make sure there is a trailing slash
   remaining = remaining.endsWith('/') ? remaining : `${remaining}/`;
 
-  const prefix = options?.path?.replace(/^\//, ''); // Remove extra leading slash
+  if (prefixRegex) {
+    const prefixMatch = remaining.match(prefixRegex);
 
-  if (prefix) {
-    // Make sure there is a trailing slash
-    const normalizedPrefix = prefix.endsWith('/') ? prefix : `${prefix}/`;
-
-    // If the path doesn't start with the prefix, it's not a match
-    if (!remaining.startsWith(normalizedPrefix)) {
+    if (prefixMatch == null) {
       return undefined;
     }
 
-    // Remove the prefix from the path
-    remaining = remaining.replace(normalizedPrefix, '');
+    remaining = remaining.slice(prefixMatch[0].length);
   }
 
   if (screens === undefined) {
     // When no config is specified, use the path segments as route names
-    const routes = remaining
-      .split('/')
-      .filter(Boolean)
-      .map((segment) => {
-        const name = decodeURIComponent(segment);
-        return { name };
-      });
+    const routes: ParsedRoute[] = [];
+
+    for (const segment of remaining.split('/')) {
+      if (!segment) {
+        continue;
+      }
+
+      try {
+        routes.push({ name: decodeURIComponent(segment) });
+      } catch {
+        return undefined;
+      }
+    }
 
     if (routes.length) {
       return createNestedStateObject(path, routes, initialRoutes);
@@ -122,41 +290,143 @@ export function getStateFromPath<ParamList extends {}>(
   if (remaining === '/') {
     // We need to add special handling of empty path so navigation to empty path also works
     // When handling empty path, we should only look at the root level config
-    const match = configs.find((config) => config.segments.join('/') === '');
+    const match = configs.find((config) => config.pattern === '');
 
     if (match) {
-      return createNestedStateObject(
+      const config = resolveSharedConfig(match);
+
+      const state = createNestedStateObject(
         path,
-        match.routeNames.map((name) => ({ name })),
+        config.routeNames.map((name) => ({ name })),
         initialRoutes,
-        configs
+        config
       );
+
+      if (state) {
+        return state;
+      }
+    }
+
+    for (const config of configsWithZeroOrMore) {
+      const routes = matchAgainstConfig('', config, configsByScreen);
+
+      if (routes) {
+        let selectedConfig = resolveSharedConfig(config);
+        let selectedRoutes = routes;
+
+        if (selectedConfig !== config) {
+          const rematchedRoutes = matchAgainstConfig(
+            '',
+            selectedConfig,
+            configsByScreen
+          );
+
+          if (rematchedRoutes === undefined) {
+            selectedConfig = config;
+          } else {
+            selectedRoutes = rematchedRoutes;
+          }
+        }
+
+        const state = createNestedStateObject(
+          path,
+          selectedRoutes,
+          initialRoutes,
+          selectedConfig
+        );
+
+        if (state) {
+          return state;
+        }
+      }
     }
 
     return undefined;
   }
 
-  let result: PartialState<NavigationState> | undefined;
-  let current: PartialState<NavigationState> | undefined;
-
   // We match the whole path against the regex instead of segments
   // This makes sure matches such as wildcard will catch any unmatched routes, even if nested
-  const { routes, remainingPath } = matchAgainstConfigs(remaining, configs);
+  const firstRawSegment = remaining.split('/')[0];
+
+  let firstDecodedSegment: string | undefined;
 
-  if (routes !== undefined) {
-    // This will always be empty if full path matched
-    current = createNestedStateObject(path, routes, initialRoutes, configs);
-    remaining = remainingPath;
-    result = current;
+  try {
+    firstDecodedSegment =
+      firstRawSegment != null ? decodeURIComponent(firstRawSegment) : undefined;
+  } catch {
+    firstDecodedSegment = undefined;
   }
 
-  if (current == null || result == null) {
-    return undefined;
+  for (const config of configs) {
+    // Regex matching is expensive, so skip configs that can't match this path.
+    if (
+      !canMatchFirstSegment(
+        config.segments[0],
+        firstDecodedSegment,
+        firstRawSegment
+      )
+    ) {
+      continue;
+    }
+
+    const routes = matchAgainstConfig(remaining, config, configsByScreen);
+
+    if (routes === undefined) {
+      continue;
+    }
+
+    let selectedConfig = resolveSharedConfig(config);
+    let selectedRoutes = routes;
+
+    if (selectedConfig !== config) {
+      const rematchedRoutes = matchAgainstConfig(
+        remaining,
+        selectedConfig,
+        configsByScreen
+      );
+
+      if (rematchedRoutes === undefined) {
+        selectedConfig = config;
+      } else {
+        selectedRoutes = rematchedRoutes;
+      }
+    }
+
+    const state = createNestedStateObject(
+      path,
+      selectedRoutes,
+      initialRoutes,
+      selectedConfig
+    );
+
+    if (state !== undefined) {
+      return state;
+    }
   }
 
-  return result;
+  return undefined;
 }
 
+const canMatchFirstSegment = (
+  configSegment: string | undefined,
+  decodedSegment: string | undefined,
+  rawSegment: string | undefined
+) => {
+  if (decodedSegment === undefined) {
+    return true;
+  }
+
+  if (configSegment === undefined) {
+    return false;
+  }
+
+  if (configSegment === '*' || configSegment.startsWith(':')) {
+    return true;
+  }
+
+  return configSegment === decodedSegment || configSegment === rawSegment;
+};
+
 /**
  * Reference to the last used config resources. This is used to avoid recomputing the config resources when the options are the same.
  */
@@ -165,11 +435,17 @@ const cachedConfigResources = new WeakMap<Options<{}>, ConfigResources>();
 function getConfigResources<ParamList extends {}>(
   options: Options<ParamList> | undefined
 ) {
-  if (!options) return prepareConfigResources();
+  if (!options) {
+    return prepareConfigResources();
+  }
 
   const cached = cachedConfigResources.get(options);
 
-  if (cached) return cached;
+  if (cached) {
+    return cached;
+  }
+
+  validatePathConfig(options);
 
   const resources = prepareConfigResources(options);
 
@@ -179,21 +455,50 @@ function getConfigResources<ParamList extends {}>(
 }
 
 function prepareConfigResources(options?: Options<{}>) {
-  if (options) {
-    validatePathConfig(options);
-  }
-
   const initialRoutes = getInitialRoutes(options);
   const configs = getSortedNormalizedConfigs(initialRoutes, options?.screens);
+  const prefix = options?.path?.replace(/^\//, '');
 
-  checkForDuplicatedConfigs(configs);
+  let prefixRegex: RegExp | undefined;
 
-  const configWithRegexes = getConfigsWithRegexes(configs);
+  if (prefix) {
+    const normalizedPrefix = prefix.endsWith('/') ? prefix : `${prefix}/`;
+    const prefixPattern = normalizedPrefix
+      .split('/')
+      .map(getStaticSegmentPattern)
+      .join('/');
+
+    prefixRegex = new RegExp(`^${prefixPattern}`);
+  }
+
+  const configsByScreen: Record<string, RouteConfig[]> = {};
+  const configsByPattern: Record<string, RouteConfig[]> = {};
+  const configsWithZeroOrMore: RouteConfig[] = [];
+
+  for (const c of configs) {
+    if (c.params.some((param) => param.repeat === 'zero-or-more')) {
+      configsWithZeroOrMore.push(c);
+    }
+
+    (configsByScreen[c.screen] ??= []).push(c);
+
+    const existing = configsByPattern[c.pattern];
+
+    if (existing) {
+      checkForDuplicatedConfigs(existing[existing.length - 1], c);
+      existing.push(c);
+    } else {
+      configsByPattern[c.pattern] = [c];
+    }
+  }
 
   return {
     initialRoutes,
     configs,
-    configWithRegexes,
+    configsWithZeroOrMore,
+    configsByScreen,
+    configsByPattern,
+    prefixRegex,
   };
 }
 
@@ -215,216 +520,304 @@ function getSortedNormalizedConfigs(
   screens: Record<string, string | PathConfig<{}>> = {}
 ) {
   // Create a normalized configs array which will be easier to use
-  return ([] as RouteConfig[])
-    .concat(
-      ...Object.keys(screens).map((key) =>
-        createNormalizedConfigs(key, screens, initialRoutes, [], [], [])
-      )
-    )
-    .sort((a, b) => {
-      // Sort config from most specific to least specific:
-      // - more segments
-      // - static segments
-      // - params with regex
-      // - regular params
-      // - wildcard
-
-      // If 2 patterns are same, move the one with less route names up
-      // This is an error state, so it's only useful for consistent error messages
-      if (isArrayEqual(a.segments, b.segments)) {
-        return b.routeNames.join('>').localeCompare(a.routeNames.join('>'));
-      }
+  const configs: RouteConfig[] = [];
+
+  for (const key in screens) {
+    setupNormalizedConfigs(key, screens, initialRoutes, configs, [], [], []);
+  }
+
+  for (let order = 0; order < configs.length; order++) {
+    const config = configs[order];
+
+    if (config) {
+      config.order = order;
+    }
+  }
 
-      // If one of the patterns starts with the other, it's more exhaustive
-      // So move it up
-      if (arrayStartsWith(a.segments, b.segments)) {
+  return configs.sort((a, b) => {
+    // Sort config from most specific to least specific:
+    // - static segments
+    // - params with regex
+    // - regular params
+    // - one-or-more params
+    // - the end of the pattern
+    // - zero-or-more params
+    // - wildcard
+
+    // If 2 patterns are same, move the one with less route names up
+    // This is an error state, so it's only useful for consistent error messages
+    if (a.pattern === b.pattern && isArrayEqual(a.segments, b.segments)) {
+      if (
+        a.routeNames.length > b.routeNames.length &&
+        arrayStartsWith(a.routeNames, b.routeNames)
+      ) {
         return -1;
       }
 
-      if (arrayStartsWith(b.segments, a.segments)) {
+      if (
+        b.routeNames.length > a.routeNames.length &&
+        arrayStartsWith(b.routeNames, a.routeNames)
+      ) {
         return 1;
       }
 
-      for (let i = 0; i < Math.max(a.segments.length, b.segments.length); i++) {
-        // if b is longer, b gets higher priority
-        if (a.segments[i] == null) {
-          return 1;
-        }
+      return a.routeNames.length - b.routeNames.length || a.order - b.order;
+    }
 
-        // if a is longer, a gets higher priority
-        if (b.segments[i] == null) {
-          return -1;
-        }
+    for (let i = 0; i < Math.max(a.segments.length, b.segments.length); i++) {
+      const rank = (a.segmentRanks[i] ?? 5) - (b.segmentRanks[i] ?? 5);
+
+      if (rank !== 0) {
+        return rank;
+      }
+    }
+
+    return a.order - b.order;
+  });
+}
+
+const getSegmentRank = (segment: string | undefined) => {
+  if (segment === undefined) {
+    return 5;
+  }
+
+  if (segment === '*') {
+    return 8;
+  }
+
+  if (!segment.startsWith(':')) {
+    return 0;
+  }
+
+  const regex = segment.includes('(');
+
+  if (segment.endsWith('+')) {
+    return regex ? 3 : 4;
+  }
+
+  if (segment.endsWith('*')) {
+    return regex ? 6 : 7;
+  }
+
+  return regex ? 1 : 2;
+};
+
+// Throw if two configs resolve to the same pattern but conflicting screens
+function checkForDuplicatedConfigs(
+  existing: RouteConfig | undefined,
+  config: RouteConfig
+) {
+  if (!existing) {
+    return;
+  }
+
+  const a = existing.routeNames;
+  const b = config.routeNames;
+
+  // It's not a problem if the path string omitted from an innermost screen
+  // For example, it's ok if a path resolves to `A > B > C` or `A > B`
+  const intersects =
+    a.length > b.length ? arrayStartsWith(a, b) : arrayStartsWith(b, a);
+
+  if (!intersects && (!existing.shared || !config.shared)) {
+    throw new Error(
+      `Found conflicting screens with the same pattern. The pattern '${
+        config.pattern
+      }' resolves to both '${a.join(' > ')}' and '${b.join(
+        ' > '
+      )}'. Patterns must be unique and cannot resolve to more than one screen unless shared: true is specified.`
+    );
+  }
+}
+
+const matchAgainstConfig = (
+  remaining: string,
+  config: RouteConfig,
+  configsByScreen: Record<string, RouteConfig[]>
+) => {
+  if (!config.regex) {
+    return undefined;
+  }
+
+  const match = remaining.match(config.regex);
+
+  if (!match) {
+    return undefined;
+  }
 
-        const aWildCard = a.segments[i] === '*';
-        const bWildCard = b.segments[i] === '*';
-        const aParam = a.segments[i].startsWith(':');
-        const bParam = b.segments[i].startsWith(':');
-        const aRegex = aParam && a.segments[i].includes('(');
-        const bRegex = bParam && b.segments[i].includes('(');
+  let validationFailed = false;
+  const matchedRoutes: ParsedRoute[] = [];
 
-        // if both are wildcard or regex, we compare next component
-        if ((aWildCard && bWildCard) || (aRegex && bRegex)) {
+  for (const [index, routeName] of config.routeNames.entries()) {
+    // Check matching name, route names and pattern in case same screen is used
+    // at different levels or branches in config
+    const routeConfig = configsByScreen[routeName]?.find(
+      (c) =>
+        index === c.routeNames.length - 1 &&
+        arrayStartsWith(config.routeNames, c.routeNames) &&
+        arrayStartsWith(config.segments, c.segments)
+    );
+
+    let params: Record<string, unknown> | undefined;
+    let hasParams = false;
+
+    if (routeConfig && match.groups) {
+      params = {};
+
+      for (const param of routeConfig.params) {
+        if (param.screen !== routeName) {
           continue;
         }
 
-        // if only a is wildcard, b gets higher priority
-        if (aWildCard && !bWildCard) {
-          return 1;
-        }
+        let value = match.groups[`${PARAM_GROUP_PREFIX}${param.index}`];
 
-        // if only b is wildcard, a gets higher priority
-        if (bWildCard && !aWildCard) {
-          return -1;
+        if (param.repeat && value != null) {
+          value = value.replace(/\/$/, '');
         }
 
-        // If only a has a param, b gets higher priority
-        if (aParam && !bParam) {
-          return 1;
-        }
+        let decoded: string;
+        let decodedSegments: string[] | undefined;
 
-        // If only b has a param, a gets higher priority
-        if (bParam && !aParam) {
-          return -1;
+        try {
+          if (param.repeat) {
+            if (value == null) {
+              decodedSegments = [];
+            } else {
+              decodedSegments = value.split('/').map(decodeURIComponent);
+            }
+
+            decoded = decodedSegments.join('/');
+          } else {
+            if (value == null) {
+              params[param.name] = undefined;
+              hasParams = true;
+              continue;
+            }
+
+            decoded = decodeURIComponent(value);
+          }
+        } catch {
+          return undefined;
         }
 
-        // if only a has regex, a gets higher priority
-        if (aRegex && !bRegex) {
-          return -1;
+        // Percent-encoded values are matched permissively
+        // So validate the decoded value against the custom regex
+        if (param.regex) {
+          const regex = param.regex;
+          const values = decodedSegments ?? [decoded];
+          const rawValues = param.repeat ? (value?.split('/') ?? []) : [value];
+
+          if (
+            values.some(
+              (item, index) => item !== rawValues[index] && !regex.test(item)
+            )
+          ) {
+            return undefined;
+          }
         }
 
-        // if only b has regex, b gets higher priority
-        if (bRegex && !aRegex) {
-          return 1;
+        const parser = routeConfig.parse?.[param.name];
+
+        if (!parser) {
+          params[param.name] = decoded;
+          hasParams = true;
+          continue;
         }
-      }
 
-      return a.segments.length - b.segments.length;
-    });
-}
+        const schema = getStandardSchema(parser);
 
-function checkForDuplicatedConfigs(configs: RouteConfig[]) {
-  // Check for duplicate patterns in the config
-  configs.reduce<Record<string, RouteConfig>>((acc, config) => {
-    const pattern = config.segments.join('/');
-
-    if (acc[pattern]) {
-      const a = acc[pattern].routeNames;
-      const b = config.routeNames;
-
-      // It's not a problem if the path string omitted from a inner most screen
-      // For example, it's ok if a path resolves to `A > B > C` or `A > B`
-      const intersects =
-        a.length > b.length
-          ? b.every((it, i) => a[i] === it)
-          : a.every((it, i) => b[i] === it);
-
-      if (!intersects) {
-        throw new Error(
-          `Found conflicting screens with the same pattern. The pattern '${
-            pattern
-          }' resolves to both '${a.join(' > ')}' and '${b.join(
-            ' > '
-          )}'. Patterns must be unique and cannot resolve to more than one screen.`
-        );
-      }
-    }
+        if (schema) {
+          const result = getValidationResult(schema, decoded);
 
-    return Object.assign(acc, {
-      [pattern]: config,
-    });
-  }, {});
-}
+          if (result.issues) {
+            validationFailed = true;
+            break;
+          }
 
-function getConfigsWithRegexes(configs: RouteConfig[]) {
-  return configs.map((c) => ({
-    ...c,
-    // Add `$` to the regex to make sure it matches till end of the path and not just beginning
-    regex: c.regex ? new RegExp(c.regex.source + '$') : undefined,
-  }));
-}
+          params[param.name] = result.value;
+          hasParams = true;
+          continue;
+        }
 
-const matchAgainstConfigs = (remaining: string, configs: RouteConfig[]) => {
-  let routes: ParsedRoute[] | undefined;
-  let remainingPath = remaining;
+        if (typeof parser === 'function') {
+          params[param.name] = parser(decoded);
+          hasParams = true;
+          continue;
+        }
 
-  // Go through all configs, and see if the next path segment matches our regex
-  for (const config of configs) {
-    if (!config.regex) {
-      continue;
-    }
+        throw new Error(INVALID_PARSER_ERROR);
+      }
 
-    const match = remainingPath.match(config.regex);
+      if (validationFailed) {
+        // A failed param validation invalidates the whole nested route chain for this config.
+        break;
+      }
+    }
 
-    // If our regex matches, we need to extract params from the path
-    if (match) {
-      routes = config.routeNames.map((routeName) => {
-        const routeConfig = configs.find((c) => {
-          // Check matching name AND pattern in case same screen is used at different levels in config
-          return (
-            c.screen === routeName &&
-            arrayStartsWith(config.segments, c.segments)
-          );
-        });
+    if (params && hasParams) {
+      matchedRoutes.push({ name: routeName, params });
+    } else {
+      matchedRoutes.push({ name: routeName });
+    }
+  }
 
-        const params =
-          routeConfig && match.groups
-            ? Object.fromEntries(
-                Object.entries(match.groups)
-                  .map(([key, value]) => {
-                    const index = Number(key.replace('param_', ''));
-                    const param = routeConfig.params.find(
-                      (it) => it.index === index
-                    );
-
-                    if (param?.screen === routeName && param?.name) {
-                      return [param.name, value];
-                    }
-
-                    return null;
-                  })
-                  .filter((it) => it != null)
-                  .map(([key, value]) => {
-                    if (value == null) {
-                      return [key, undefined];
-                    }
-
-                    const decoded = decodeURIComponent(value);
-                    const parsed = routeConfig.parse?.[key]
-                      ? routeConfig.parse[key](decoded)
-                      : decoded;
-
-                    return [key, parsed];
-                  })
-              )
-            : undefined;
+  if (validationFailed) {
+    return undefined;
+  }
 
-        if (params && Object.keys(params).length) {
-          return { name: routeName, params };
-        }
+  return matchedRoutes;
+};
 
-        return { name: routeName };
-      });
+const getRoutePatternParts = (
+  path: string,
+  screen: string
+): RoutePatternPart[] =>
+  getPatternParts(path).map((part) => {
+    const rank = getSegmentRank(part.segment);
 
-      remainingPath = remainingPath.replace(match[0], '');
+    if (part.name) {
+      return {
+        type: 'param',
+        screen,
+        segment: part.segment,
+        rank,
+        name: part.name,
+        ...(part.pattern
+          ? {
+              pattern: part.pattern,
+              regex: new RegExp(`^(?:${part.pattern})$`),
+            }
+          : null),
+        ...(part.optional ? { optional: true } : null),
+        ...(part.repeat ? { repeat: part.repeat } : null),
+      };
+    }
 
-      break;
+    if (part.segment === '*') {
+      return {
+        type: 'wildcard',
+        segment: part.segment,
+        rank,
+      };
     }
-  }
 
-  return { routes, remainingPath };
-};
+    return {
+      type: 'static',
+      segment: part.segment,
+      rank,
+      pattern: getStaticSegmentPattern(part.segment),
+    };
+  });
 
-const createNormalizedConfigs = (
+const setupNormalizedConfigs = (
   screen: string,
   routeConfig: Record<string, string | PathConfig<{}>>,
   initials: InitialRouteConfig[],
-  paths: { screen: string; path: string }[],
+  configs: RouteConfig[],
+  parts: RoutePatternPart[],
   parentScreens: string[],
   routeNames: string[]
-): RouteConfig[] => {
-  const configs: RouteConfig[] = [];
-
+): void => {
   routeNames.push(screen);
 
   parentScreens.push(screen);
@@ -432,19 +825,31 @@ const createNormalizedConfigs = (
   const config = routeConfig[screen];
 
   if (typeof config === 'string') {
-    paths.push({ screen, path: config });
-    configs.push(createConfigItem(screen, [...routeNames], [...paths]));
+    const configParts = combinePatternParts(
+      parts,
+      getRoutePatternParts(config, screen)
+    );
+
+    configs.push(createConfigItem(screen, [...routeNames], configParts));
   } else if (typeof config === 'object') {
     // if an object is specified as the value (e.g. Foo: { ... }),
     // it can have `path` property and
     // it could have `screens` prop which has nested configs
-    if (typeof config.path === 'string') {
-      if (config.exact && config.path == null) {
-        throw new Error(
-          `Screen '${screen}' doesn't specify a 'path'. A 'path' needs to be specified when specifying 'exact: true'. If you don't want this screen in the URL, specify it as empty string, e.g. \`path: ''\`.`
-        );
-      }
+    const nestedScreens =
+      'screens' in config
+        ? (config.screens as Record<string, string | PathConfig<{}>>)
+        : undefined;
+    const hasNestedScreens = !!nestedScreens;
+    const currentParts =
+      typeof config.path === 'string'
+        ? combinePatternParts(
+            parts,
+            getRoutePatternParts(config.path, screen),
+            config.exact
+          )
+        : parts;
 
+    if (typeof config.path === 'string') {
       // We should add alias configs after the main config
       // So unless they are more specific, main config will be matched first
       const aliasConfigs = [];
@@ -456,8 +861,10 @@ const createNormalizedConfigs = (
               createConfigItem(
                 screen,
                 [...routeNames],
-                [...paths, { screen, path: alias }],
-                config.parse
+                combinePatternParts(parts, getRoutePatternParts(alias, screen)),
+                config.parse,
+                hasNestedScreens,
+                false
               )
             );
           } else if (typeof alias === 'object') {
@@ -465,25 +872,29 @@ const createNormalizedConfigs = (
               createConfigItem(
                 screen,
                 [...routeNames],
-                alias.exact
-                  ? [{ screen, path: alias.path }]
-                  : [...paths, { screen, path: alias.path }],
-                alias.parse
+                combinePatternParts(
+                  parts,
+                  getRoutePatternParts(alias.path, screen),
+                  alias.exact
+                ),
+                alias.parse,
+                hasNestedScreens,
+                alias.shared === true
               )
             );
           }
         }
       }
 
-      if (config.exact) {
-        // If it's an exact path, we don't need to keep track of the parent screens
-        // So we can clear it
-        paths.length = 0;
-      }
-
-      paths.push({ screen, path: config.path });
       configs.push(
-        createConfigItem(screen, [...routeNames], [...paths], config.parse)
+        createConfigItem(
+          screen,
+          [...routeNames],
+          currentParts,
+          config.parse,
+          hasNestedScreens,
+          config.shared === true
+        )
       );
 
       configs.push(...aliasConfigs);
@@ -499,7 +910,7 @@ const createNormalizedConfigs = (
       );
     }
 
-    if ('screens' in config && config.screens) {
+    if (nestedScreens) {
       // property `initialRouteName` without `screens` has no purpose
       if (
         'initialRouteName' in config &&
@@ -511,89 +922,189 @@ const createNormalizedConfigs = (
         });
       }
 
-      Object.keys(config.screens).forEach((nestedConfig) => {
-        const result = createNormalizedConfigs(
+      for (const nestedConfig in nestedScreens) {
+        setupNormalizedConfigs(
           nestedConfig,
-          config.screens as Record<string, string | PathConfig<{}>>,
+          nestedScreens,
           initials,
-          [...paths],
+          configs,
+          currentParts,
           [...parentScreens],
           routeNames
         );
-
-        configs.push(...result);
-      });
+      }
     }
   }
 
   routeNames.pop();
-
-  return configs;
 };
 
 const createConfigItem = (
   screen: string,
   routeNames: string[],
-  paths: { screen: string; path: string }[],
-  parse?: ParseConfig
+  parts: RoutePatternPart[],
+  parse?: ParseConfig,
+  hasNestedScreens = false,
+  shared = false
 ): RouteConfig => {
-  const parts: (PatternPart & { screen: string })[] = [];
+  let regex: RegExp | undefined;
 
-  // Parse the path string into parts for easier matching
-  for (const { screen, path } of paths) {
-    parts.push(...getPatternParts(path).map((part) => ({ ...part, screen })));
-  }
+  const segments: string[] = [];
+  const segmentRanks: number[] = [];
+  const params: RouteConfig['params'] = [];
+  const pathParamNames = new Set<string>();
 
-  const regex = parts.length
-    ? new RegExp(
-        `^(${parts
-          .map((it, i) => {
-            if (it.param) {
-              const reg = it.regex || '[^/]+';
+  if (parts.length) {
+    let regexString = '^(';
+    let index = 0;
 
-              return `(((?<param_${i}>${reg})\\/)${it.optional ? '?' : ''})`;
-            }
+    for (const part of parts) {
+      segments.push(part.segment);
+      segmentRanks.push(part.rank);
 
-            return `${it.segment === '*' ? '.*' : escape(it.segment)}\\/`;
-          })
-          .join('')})$`
-      )
-    : undefined;
-
-  const segments = parts.map((it) => it.segment);
-  const params = parts
-    .map((it, i) =>
-      it.param
-        ? {
-            index: i,
-            screen: it.screen,
-            name: it.param,
-          }
-        : null
-    )
-    .filter((it) => it != null);
+      if (part.type === 'param') {
+        // A custom regex may not match the percent-encoded form of the value
+        // So also accept segments containing an encoded character and validate them after decoding
+        let reg = '[^/]+';
+
+        if (part.pattern) {
+          const encodedReg = `(?=[^/]*%[0-9A-F]{2})[^/]+`;
+
+          reg = part.repeat
+            ? `(?:${encodedReg})|(?![^/]*%[0-9A-F]{2})(?:${part.pattern})`
+            : `(?:${part.pattern})|${encodedReg}`;
+        }
+
+        if (part.repeat) {
+          const repeatedReg = `(?:(?:${reg})\\/)+`;
+
+          regexString += `(?<${PARAM_GROUP_PREFIX}${index}>${repeatedReg})${
+            part.repeat === 'zero-or-more' ? '?' : ''
+          }`;
+        } else {
+          regexString += `(((?<${PARAM_GROUP_PREFIX}${index}>${reg})\\/)${part.optional ? '?' : ''})`;
+        }
+
+        params.push({
+          index,
+          screen: part.screen,
+          name: part.name,
+          regex: part.regex,
+          ...(part.repeat ? { repeat: part.repeat } : {}),
+        });
+
+        if (part.screen === screen) {
+          pathParamNames.add(part.name);
+        }
+      } else if (part.type === 'wildcard') {
+        regexString += `.*\\/`;
+      } else {
+        regexString += `${part.pattern}\\/`;
+      }
+
+      index++;
+    }
+
+    regexString += ')$';
+    regex = new RegExp(regexString);
+  }
+
+  const pattern = segments.join('/');
 
   return {
     screen,
+    order: 0,
     regex,
+    pattern,
     segments,
+    segmentRanks,
     params,
     routeNames,
     parse,
+    explicitParamNames: getExplicitParamNames(parse),
+    pathParamNames,
+    hasNestedScreens,
+    shared,
   };
 };
 
-const findParseConfigForRoute = (
-  routeName: string,
-  flatConfig: RouteConfig[]
-): ParseConfig | undefined => {
-  for (const config of flatConfig) {
-    if (routeName === config.routeNames[config.routeNames.length - 1]) {
-      return config.parse;
+const selectSharedConfig = (
+  match: RouteConfig,
+  candidates: RouteConfig[],
+  previous: NavigationState | PartialState<NavigationState> | undefined,
+  initialRoutes: InitialRouteConfig[]
+) => {
+  // Walk the previous state down to the focused leaf to get the active route path
+  const focusedRouteNames: string[] = [];
+
+  let current = previous;
+
+  while (current?.routes.length) {
+    const index =
+      typeof current.index === 'number'
+        ? current.index
+        : current.routes.length - 1;
+
+    const route = current.routes[index];
+
+    if (route == null) {
+      break;
     }
+
+    focusedRouteNames.push(route.name);
+    current = route.state;
   }
 
-  return undefined;
+  // Rank a candidate by how far it aligns with the focused path, then by
+  // how many of its levels match a configured initial route
+  const score = (routeNames: string[]) => {
+    let focused = 0;
+
+    while (
+      routeNames[focused] !== undefined &&
+      routeNames[focused] === focusedRouteNames[focused]
+    ) {
+      focused++;
+    }
+
+    let initial = 0;
+
+    for (const config of initialRoutes) {
+      if (
+        arrayStartsWith(routeNames, config.parentScreens) &&
+        routeNames[config.parentScreens.length] === config.initialRouteName
+      ) {
+        initial++;
+      }
+    }
+
+    return { focused, initial };
+  };
+
+  let selected = match;
+  let best = { focused: -1, initial: -1 };
+
+  for (const candidate of candidates) {
+    if (!candidate.shared) {
+      continue;
+    }
+
+    const { focused, initial } = score(candidate.routeNames);
+
+    const better =
+      focused !== best.focused
+        ? focused > best.focused
+        : initial !== best.initial
+          ? initial > best.initial
+          : candidate.order < selected.order;
+
+    if (better) {
+      selected = candidate;
+      best = { focused, initial };
+    }
+  }
+
+  return selected;
 };
 
 // Try to find an initial route connected with the one passed
@@ -606,7 +1117,14 @@ const findInitialRoute = (
     if (parentScreens.length === config.parentScreens.length) {
       let sameParents = true;
       for (let i = 0; i < parentScreens.length; i++) {
-        if (parentScreens[i].localeCompare(config.parentScreens[i]) !== 0) {
+        const parentScreen = parentScreens[i];
+        const configParentScreen = config.parentScreens[i];
+
+        if (
+          parentScreen == null ||
+          configParentScreen == null ||
+          parentScreen.localeCompare(configParentScreen) !== 0
+        ) {
           sameParents = false;
           break;
         }
@@ -627,7 +1145,7 @@ const createStateObject = (
   initialRoute: string | undefined,
   route: ParsedRoute,
   isEmpty: boolean
-): InitialState => {
+): PartialState<NavigationState> => {
   if (isEmpty) {
     if (initialRoute) {
       return {
@@ -657,75 +1175,184 @@ const createNestedStateObject = (
   path: string,
   routes: ParsedRoute[],
   initialRoutes: InitialRouteConfig[],
-  flatConfig?: RouteConfig[]
-) => {
-  let route = routes.shift() as ParsedRoute;
+  routeConfig?: RouteConfig
+): PartialState<NavigationState> | undefined => {
+  const focusedRoute = routes[routes.length - 1];
+
+  if (focusedRoute == null) {
+    return undefined;
+  }
+
+  focusedRoute.path = path.replace(/\/$/, '');
+
+  const queryParams = parseQueryParams(
+    path,
+    routeConfig?.parse,
+    routeConfig?.pathParamNames,
+    routeConfig?.explicitParamNames,
+    routeConfig?.hasNestedScreens,
+    focusedRoute.params
+  );
+
+  if (!queryParams.valid) {
+    return undefined;
+  }
+
+  if (queryParams.params) {
+    focusedRoute.params = { ...focusedRoute.params, ...queryParams.params };
+  }
+
+  let route = routes.shift();
+
+  if (route == null) {
+    return undefined;
+  }
+
   const parentScreens: string[] = [];
 
   let initialRoute = findInitialRoute(route.name, parentScreens, initialRoutes);
 
   parentScreens.push(route.name);
 
-  const state: InitialState = createStateObject(
-    initialRoute,
-    route,
-    routes.length === 0
-  );
+  const state = createStateObject(initialRoute, route, routes.length === 0);
 
   if (routes.length > 0) {
     let nestedState = state;
 
-    while ((route = routes.shift() as ParsedRoute)) {
+    let nextRoute = routes.shift();
+
+    while (nextRoute != null) {
+      route = nextRoute;
       initialRoute = findInitialRoute(route.name, parentScreens, initialRoutes);
 
       const nestedStateIndex =
-        nestedState.index || nestedState.routes.length - 1;
+        nestedState.index ?? nestedState.routes.length - 1;
+      const nestedRoute = nestedState.routes[nestedStateIndex];
+
+      if (nestedRoute == null) {
+        throw new Error(`Couldn't find a route at index ${nestedStateIndex}.`);
+      }
 
-      nestedState.routes[nestedStateIndex].state = createStateObject(
+      nestedRoute.state = createStateObject(
         initialRoute,
         route,
         routes.length === 0
       );
 
       if (routes.length > 0) {
-        nestedState = nestedState.routes[nestedStateIndex]
-          .state as InitialState;
+        if (nestedRoute.state == null) {
+          throw new Error(
+            `Couldn't find nested state for route '${route.name}'.`
+          );
+        }
+
+        nestedState = nestedRoute.state;
       }
 
       parentScreens.push(route.name);
+      nextRoute = routes.shift();
     }
   }
 
-  route = findFocusedRoute(state) as ParsedRoute;
-  route.path = path.replace(/\/$/, '');
-
-  const params = parseQueryParams(
-    path,
-    flatConfig ? findParseConfigForRoute(route.name, flatConfig) : undefined
-  );
-
-  if (params) {
-    route.params = { ...route.params, ...params };
-  }
-
   return state;
 };
 
-const parseQueryParams = (path: string, parseConfig?: ParseConfig) => {
-  const query = path.split('?')[1];
-  const params: Record<string, unknown> = queryString.parse(query);
+const parseQueryParams = (
+  path: string,
+  parseConfig?: ParseConfig,
+  pathParamNames: Set<string> = new Set(),
+  explicitParamNames?: Set<string>,
+  hasNestedScreens = false,
+  routeParams?: object
+):
+  | { valid: true; params?: Record<string, unknown> | undefined }
+  | { valid: false } => {
+  const queryIndex = path.indexOf('?');
+  const query = queryIndex === -1 ? undefined : path.slice(queryIndex + 1);
+  const params: Record<string, unknown> = query ? queryString.parse(query) : {};
+
+  // Path params should always win over same-named query params.
+  for (const name of pathParamNames) {
+    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+    delete params[name];
+  }
 
   if (parseConfig) {
-    Object.keys(params).forEach((name) => {
-      if (
-        Object.hasOwnProperty.call(parseConfig, name) &&
-        parseConfig[name] &&
-        typeof params[name] === 'string'
-      ) {
-        params[name] = parseConfig[name](params[name]);
+    for (const name in parseConfig) {
+      const parser = parseConfig[name];
+
+      if (!parser || pathParamNames.has(name)) {
+        continue;
       }
-    });
+
+      const schema = getStandardSchema(parser);
+
+      if (!Object.hasOwn(params, name)) {
+        if (!schema) {
+          continue;
+        }
+
+        const result = getValidationResult(schema, undefined);
+
+        if (result.issues) {
+          return { valid: false };
+        }
+
+        if (result.value !== undefined) {
+          params[name] = result.value;
+        }
+
+        continue;
+      }
+
+      if (schema) {
+        const result = getValidationResult(schema, params[name]);
+
+        if (result.issues) {
+          return { valid: false };
+        }
+
+        params[name] = result.value;
+        continue;
+      }
+
+      const value = Array.isArray(params[name])
+        ? params[name][0]
+        : params[name];
+
+      if (typeof value !== 'string') {
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+        delete params[name];
+        continue;
+      }
+
+      if (typeof parser === 'function') {
+        params[name] = parser(value);
+        continue;
+      }
+
+      throw new Error(INVALID_PARSER_ERROR);
+    }
   }
 
-  return Object.keys(params).length ? params : undefined;
+  if (
+    hasNestedScreens &&
+    !explicitParamNames?.has('screen') &&
+    (typeof params.screen === 'string' ||
+      (routeParams != null &&
+        'screen' in routeParams &&
+        typeof routeParams.screen === 'string'))
+  ) {
+    for (const name of NESTED_SCREEN_PARAM_NAMES) {
+      if (!explicitParamNames?.has(name)) {
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+        delete params[name];
+      }
+    }
+  }
+
+  return {
+    valid: true,
+    params: Object.keys(params).length ? params : undefined,
+  };
 };