expo-router 0.0.35 → 0.0.37

package/build/Route.d.ts

@@ -1,18 +1,18 @@
-import React, { ReactNode } from "react";
+import { ReactNode } from "react";
 /** The list of input keys will become optional, everything else will remain the same. */
 export declare type PickPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export declare type RouteNode = {
+    /** Load a route into memory. Returns the exports from a route. */
+    loadRoute: () => any;
+    /** Loaded initial route name. */
+    initialRouteName?: string;
     /** nested routes */
     children: RouteNode[];
-    /** Lazily get the React component */
-    getComponent: () => React.ComponentType<any>;
     /** Is the route a dynamic path */
     dynamic: null | {
         name: string;
         deep: boolean;
     };
-    /** All static exports from the file. */
-    getExtras: () => Record<string, any>;
     /** `index`, `error-boundary`, etc. */
     route: string;
     /** require.context key, used for matching children. */
@@ -31,5 +31,6 @@ export declare function Route({ children, node, }: {
     node: RouteNode;
 }): JSX.Element;
 export declare function useRootRoute(): RouteNode | null;
+export declare function sortRoutesWithInitial(initialRouteName?: string): (a: RouteNode, b: RouteNode) => number;
 export declare function sortRoutes(a: RouteNode, b: RouteNode): number;
 //# sourceMappingURL=Route.d.ts.map

package/build/Route.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../src/Route.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAc,MAAM,OAAO,CAAC;AAKrD,yFAAyF;AACzF,oBAAY,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACxD,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEtB,oBAAY,SAAS,GAAG;IACtB,oBAAoB;IACpB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,qCAAqC;IACrC,YAAY,EAAE,MAAM,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC7C,kCAAkC;IAClC,OAAO,EAAE,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAChD,wCAAwC;IACxC,SAAS,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,wFAAwF;IACxF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAWF,+DAA+D;AAC/D,wBAAgB,YAAY,IAAI,SAAS,GAAG,IAAI,CAE/C;AAED,wBAAgB,aAAa,IAAI,MAAM,CAMtC;AAED,iEAAiE;AACjE,wBAAgB,KAAK,CAAC,EACpB,QAAQ,EACR,IAAI,GACL,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;CACjB,eAkBA;AAED,wBAAgB,YAAY,IAAI,SAAS,GAAG,IAAI,CAE/C;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,MAAM,CA4B7D"}
+{"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../src/Route.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAc,MAAM,OAAO,CAAC;AAKrD,yFAAyF;AACzF,oBAAY,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACxD,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEtB,oBAAY,SAAS,GAAG;IACtB,kEAAkE;IAClE,SAAS,EAAE,MAAM,GAAG,CAAC;IAErB,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB;IACpB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,kCAAkC;IAClC,OAAO,EAAE,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAChD,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,wFAAwF;IACxF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAWF,+DAA+D;AAC/D,wBAAgB,YAAY,IAAI,SAAS,GAAG,IAAI,CAE/C;AAED,wBAAgB,aAAa,IAAI,MAAM,CAMtC;AAED,iEAAiE;AACjE,wBAAgB,KAAK,CAAC,EACpB,QAAQ,EACR,IAAI,GACL,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;CACjB,eAkBA;AAED,wBAAgB,YAAY,IAAI,SAAS,GAAG,IAAI,CAE/C;AAED,wBAAgB,qBAAqB,CAAC,gBAAgB,CAAC,EAAE,MAAM,OAClD,SAAS,KAAK,SAAS,KAAG,MAAM,CAW5C;AACD,wBAAgB,UAAU,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,MAAM,CA4B7D"}

package/build/Route.js

@@ -35,6 +35,19 @@ export function Route({ children, node, }) {
 export function useRootRoute() {
     return useContext(RootRouteNodeContext);
 }
+export function sortRoutesWithInitial(initialRouteName) {
+    return (a, b) => {
+        if (initialRouteName) {
+            if (a.route === initialRouteName) {
+                return -1;
+            }
+            if (b.route === initialRouteName) {
+                return 1;
+            }
+        }
+        return sortRoutes(a, b);
+    };
+}
 export function sortRoutes(a, b) {
     if (a.dynamic && !b.dynamic) {
         return 1;

package/build/Route.js.map

@@ -1 +1 @@
-{"version":3,"file":"Route.js","sourceRoot":"","sources":["../src/Route.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAa,UAAU,EAAE,MAAM,OAAO,CAAC;AAErD,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AA0BpE,MAAM,uBAAuB,GAAG,KAAK,CAAC,aAAa,CAAgB,IAAI,CAAC,CAAC;AAEzE,MAAM,mBAAmB,GAAG,KAAK,CAAC,aAAa,CAAmB,IAAI,CAAC,CAAC;AAExE,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE;IACzC,uBAAuB,CAAC,WAAW,GAAG,WAAW,CAAC;IAClD,mBAAmB,CAAC,WAAW,GAAG,OAAO,CAAC;CAC3C;AAED,+DAA+D;AAC/D,MAAM,UAAU,YAAY;IAC1B,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,MAAM,QAAQ,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;IACrD,IAAI,QAAQ,IAAI,IAAI,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;KAC5E;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,KAAK,CAAC,EACpB,QAAQ,EACR,IAAI,GAIL;IACC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACpC,qEAAqE;QACrE,uBAAuB;QACvB,MAAM,MAAM,GAAG,GAAG,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC/B,OAAO,MAAM,CAAC;SACf;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEtB,OAAO,CACL,oBAAC,uBAAuB,CAAC,QAAQ,IAAC,KAAK,EAAE,UAAU;QACjD,oBAAC,mBAAmB,CAAC,QAAQ,IAAC,KAAK,EAAE,IAAI,IACtC,QAAQ,CACoB,CACE,CACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,OAAO,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,CAAY,EAAE,CAAY;IACnD,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;QAC3B,OAAO,CAAC,CAAC;KACV;IACD,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,EAAE;QAC3B,OAAO,CAAC,CAAC,CAAC;KACX;IACD,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,EAAE;QAC1B,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE;YACrC,OAAO,CAAC,CAAC;SACV;QACD,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE;YACrC,OAAO,CAAC,CAAC,CAAC;SACX;QACD,OAAO,CAAC,CAAC;KACV;IAED,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;IACzE,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;IAEzE,IAAI,MAAM,IAAI,CAAC,MAAM,EAAE;QACrB,OAAO,CAAC,CAAC,CAAC;KACX;IACD,IAAI,CAAC,MAAM,IAAI,MAAM,EAAE;QACrB,OAAO,CAAC,CAAC;KACV;IAED,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;AACzC,CAAC","sourcesContent":["import React, { ReactNode, useContext } from \"react\";\n\nimport { RootRouteNodeContext } from \"./context\";\nimport { getNameFromFilePath, matchFragmentName } from \"./matchers\";\n\n/** The list of input keys will become optional, everything else will remain the same. */\nexport type PickPartial<T, K extends keyof T> = Omit<T, K> &\n  Partial<Pick<T, K>>;\n\nexport type RouteNode = {\n  /** nested routes */\n  children: RouteNode[];\n  /** Lazily get the React component */\n  getComponent: () => React.ComponentType<any>;\n  /** Is the route a dynamic path */\n  dynamic: null | { name: string; deep: boolean };\n  /** All static exports from the file. */\n  getExtras: () => Record<string, any>;\n  /** `index`, `error-boundary`, etc. */\n  route: string;\n  /** require.context key, used for matching children. */\n  contextKey: string;\n  /** Added in-memory */\n  generated?: boolean;\n\n  /** Internal screens like the directory or the auto 404 should be marked as internal. */\n  internal?: boolean;\n};\n\nconst CurrentRoutePathContext = React.createContext<string | null>(null);\n\nconst CurrentRouteContext = React.createContext<RouteNode | null>(null);\n\nif (process.env.NODE_ENV !== \"production\") {\n  CurrentRoutePathContext.displayName = \"RoutePath\";\n  CurrentRouteContext.displayName = \"Route\";\n}\n\n/** Return the RouteNode at the current contextual boundary. */\nexport function useRouteNode(): RouteNode | null {\n  return useContext(CurrentRouteContext);\n}\n\nexport function useContextKey(): string {\n  const filename = useContext(CurrentRoutePathContext);\n  if (filename == null) {\n    throw new Error(\"No filename found. This is likely a bug in expo-router.\");\n  }\n  return filename;\n}\n\n/** Provides the matching routes and filename to the children. */\nexport function Route({\n  children,\n  node,\n}: {\n  children: ReactNode;\n  node: RouteNode;\n}) {\n  const normalName = React.useMemo(() => {\n    // The root path is `` (empty string) so always prepend `/` to ensure\n    // there is some value.\n    const normal = \"/\" + getNameFromFilePath(node.contextKey);\n    if (!normal.endsWith(\"_layout\")) {\n      return normal;\n    }\n    return normal.replace(/\\/?_layout$/, \"\");\n  }, [node.contextKey]);\n\n  return (\n    <CurrentRoutePathContext.Provider value={normalName}>\n      <CurrentRouteContext.Provider value={node}>\n        {children}\n      </CurrentRouteContext.Provider>\n    </CurrentRoutePathContext.Provider>\n  );\n}\n\nexport function useRootRoute(): RouteNode | null {\n  return useContext(RootRouteNodeContext);\n}\n\nexport function sortRoutes(a: RouteNode, b: RouteNode): number {\n  if (a.dynamic && !b.dynamic) {\n    return 1;\n  }\n  if (!a.dynamic && b.dynamic) {\n    return -1;\n  }\n  if (a.dynamic && b.dynamic) {\n    if (a.dynamic.deep && !b.dynamic.deep) {\n      return 1;\n    }\n    if (!a.dynamic.deep && b.dynamic.deep) {\n      return -1;\n    }\n    return 0;\n  }\n\n  const aIndex = a.route === \"index\" || matchFragmentName(a.route) != null;\n  const bIndex = b.route === \"index\" || matchFragmentName(b.route) != null;\n\n  if (aIndex && !bIndex) {\n    return -1;\n  }\n  if (!aIndex && bIndex) {\n    return 1;\n  }\n\n  return a.route.length - b.route.length;\n}\n"]}
+{"version":3,"file":"Route.js","sourceRoot":"","sources":["../src/Route.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAa,UAAU,EAAE,MAAM,OAAO,CAAC;AAErD,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AA2BpE,MAAM,uBAAuB,GAAG,KAAK,CAAC,aAAa,CAAgB,IAAI,CAAC,CAAC;AAEzE,MAAM,mBAAmB,GAAG,KAAK,CAAC,aAAa,CAAmB,IAAI,CAAC,CAAC;AAExE,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE;IACzC,uBAAuB,CAAC,WAAW,GAAG,WAAW,CAAC;IAClD,mBAAmB,CAAC,WAAW,GAAG,OAAO,CAAC;CAC3C;AAED,+DAA+D;AAC/D,MAAM,UAAU,YAAY;IAC1B,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,MAAM,QAAQ,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;IACrD,IAAI,QAAQ,IAAI,IAAI,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;KAC5E;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,KAAK,CAAC,EACpB,QAAQ,EACR,IAAI,GAIL;IACC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACpC,qEAAqE;QACrE,uBAAuB;QACvB,MAAM,MAAM,GAAG,GAAG,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC/B,OAAO,MAAM,CAAC;SACf;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEtB,OAAO,CACL,oBAAC,uBAAuB,CAAC,QAAQ,IAAC,KAAK,EAAE,UAAU;QACjD,oBAAC,mBAAmB,CAAC,QAAQ,IAAC,KAAK,EAAE,IAAI,IACtC,QAAQ,CACoB,CACE,CACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,OAAO,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,gBAAyB;IAC7D,OAAO,CAAC,CAAY,EAAE,CAAY,EAAU,EAAE;QAC5C,IAAI,gBAAgB,EAAE;YACpB,IAAI,CAAC,CAAC,KAAK,KAAK,gBAAgB,EAAE;gBAChC,OAAO,CAAC,CAAC,CAAC;aACX;YACD,IAAI,CAAC,CAAC,KAAK,KAAK,gBAAgB,EAAE;gBAChC,OAAO,CAAC,CAAC;aACV;SACF;QACD,OAAO,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,CAAY,EAAE,CAAY;IACnD,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;QAC3B,OAAO,CAAC,CAAC;KACV;IACD,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,EAAE;QAC3B,OAAO,CAAC,CAAC,CAAC;KACX;IACD,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,EAAE;QAC1B,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE;YACrC,OAAO,CAAC,CAAC;SACV;QACD,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE;YACrC,OAAO,CAAC,CAAC,CAAC;SACX;QACD,OAAO,CAAC,CAAC;KACV;IAED,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;IACzE,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;IAEzE,IAAI,MAAM,IAAI,CAAC,MAAM,EAAE;QACrB,OAAO,CAAC,CAAC,CAAC;KACX;IACD,IAAI,CAAC,MAAM,IAAI,MAAM,EAAE;QACrB,OAAO,CAAC,CAAC;KACV;IAED,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;AACzC,CAAC","sourcesContent":["import React, { ReactNode, useContext } from \"react\";\n\nimport { RootRouteNodeContext } from \"./context\";\nimport { getNameFromFilePath, matchFragmentName } from \"./matchers\";\n\n/** The list of input keys will become optional, everything else will remain the same. */\nexport type PickPartial<T, K extends keyof T> = Omit<T, K> &\n  Partial<Pick<T, K>>;\n\nexport type RouteNode = {\n  /** Load a route into memory. Returns the exports from a route. */\n  loadRoute: () => any;\n\n  /** Loaded initial route name. */\n  initialRouteName?: string;\n  /** nested routes */\n  children: RouteNode[];\n  /** Is the route a dynamic path */\n  dynamic: null | { name: string; deep: boolean };\n  /** `index`, `error-boundary`, etc. */\n  route: string;\n  /** require.context key, used for matching children. */\n  contextKey: string;\n  /** Added in-memory */\n  generated?: boolean;\n\n  /** Internal screens like the directory or the auto 404 should be marked as internal. */\n  internal?: boolean;\n};\n\nconst CurrentRoutePathContext = React.createContext<string | null>(null);\n\nconst CurrentRouteContext = React.createContext<RouteNode | null>(null);\n\nif (process.env.NODE_ENV !== \"production\") {\n  CurrentRoutePathContext.displayName = \"RoutePath\";\n  CurrentRouteContext.displayName = \"Route\";\n}\n\n/** Return the RouteNode at the current contextual boundary. */\nexport function useRouteNode(): RouteNode | null {\n  return useContext(CurrentRouteContext);\n}\n\nexport function useContextKey(): string {\n  const filename = useContext(CurrentRoutePathContext);\n  if (filename == null) {\n    throw new Error(\"No filename found. This is likely a bug in expo-router.\");\n  }\n  return filename;\n}\n\n/** Provides the matching routes and filename to the children. */\nexport function Route({\n  children,\n  node,\n}: {\n  children: ReactNode;\n  node: RouteNode;\n}) {\n  const normalName = React.useMemo(() => {\n    // The root path is `` (empty string) so always prepend `/` to ensure\n    // there is some value.\n    const normal = \"/\" + getNameFromFilePath(node.contextKey);\n    if (!normal.endsWith(\"_layout\")) {\n      return normal;\n    }\n    return normal.replace(/\\/?_layout$/, \"\");\n  }, [node.contextKey]);\n\n  return (\n    <CurrentRoutePathContext.Provider value={normalName}>\n      <CurrentRouteContext.Provider value={node}>\n        {children}\n      </CurrentRouteContext.Provider>\n    </CurrentRoutePathContext.Provider>\n  );\n}\n\nexport function useRootRoute(): RouteNode | null {\n  return useContext(RootRouteNodeContext);\n}\n\nexport function sortRoutesWithInitial(initialRouteName?: string) {\n  return (a: RouteNode, b: RouteNode): number => {\n    if (initialRouteName) {\n      if (a.route === initialRouteName) {\n        return -1;\n      }\n      if (b.route === initialRouteName) {\n        return 1;\n      }\n    }\n    return sortRoutes(a, b);\n  };\n}\nexport function sortRoutes(a: RouteNode, b: RouteNode): number {\n  if (a.dynamic && !b.dynamic) {\n    return 1;\n  }\n  if (!a.dynamic && b.dynamic) {\n    return -1;\n  }\n  if (a.dynamic && b.dynamic) {\n    if (a.dynamic.deep && !b.dynamic.deep) {\n      return 1;\n    }\n    if (!a.dynamic.deep && b.dynamic.deep) {\n      return -1;\n    }\n    return 0;\n  }\n\n  const aIndex = a.route === \"index\" || matchFragmentName(a.route) != null;\n  const bIndex = b.route === \"index\" || matchFragmentName(b.route) != null;\n\n  if (aIndex && !bIndex) {\n    return -1;\n  }\n  if (!aIndex && bIndex) {\n    return 1;\n  }\n\n  return a.route.length - b.route.length;\n}\n"]}

package/build/fork/getPathFromState.d.ts

@@ -34,6 +34,9 @@ export declare type State = NavigationState | Omit<PartialState<NavigationState>
  * @param options Extra options to fine-tune how to serialize the path.
  * @returns Path representing the state, e.g. /foo/bar?count=42.
  */
-export default function getPathFromState<ParamList extends object>(state: State, options?: Options<ParamList>): string;
+export default function getPathFromState<ParamList extends object>(state: State, _options?: Options<ParamList> & {
+    preserveFragments?: boolean;
+    preserveDynamicRoutes?: boolean;
+}): string;
 export {};
 //# sourceMappingURL=getPathFromState.d.ts.map

package/build/fork/getPathFromState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getPathFromState.d.ts","sourceRoot":"","sources":["../../src/fork/getPathFromState.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EAEb,MAAM,2BAA2B,CAAC;AAKnC,aAAK,OAAO,CAAC,SAAS,SAAS,MAAM,IAAI;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CACnC,CAAC;AAEF,oBAAY,KAAK,GACb,eAAe,GACf,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;AA6CjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,SAAS,SAAS,MAAM,EAC/D,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,GAC3B,MAAM,CAiMR"}
+{"version":3,"file":"getPathFromState.d.ts","sourceRoot":"","sources":["../../src/fork/getPathFromState.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EAEb,MAAM,2BAA2B,CAAC;AASnC,aAAK,OAAO,CAAC,SAAS,SAAS,MAAM,IAAI;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CACnC,CAAC;AAEF,oBAAY,KAAK,GACb,eAAe,GACf,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;AAgEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,SAAS,SAAS,MAAM,EAC/D,KAAK,EAAE,KAAK,EAEZ,QAAQ,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG;IAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC5B,GACL,MAAM,CA2BR"}

package/build/fork/getPathFromState.js

@@ -1,6 +1,6 @@
 import { validatePathConfig, } from "@react-navigation/core";
 import * as queryString from "query-string";
-import { matchDeepDynamicRouteName, matchFragmentName } from "../matchers";
+import { matchDeepDynamicRouteName, matchDynamicName, matchFragmentName, } from "../matchers";
 const getActiveRoute = (state) => {
     const route = typeof state.index === "number"
         ? state.routes[state.index]
@@ -30,6 +30,15 @@ function createFakeState(params) {
         ],
     };
 }
+function segmentMatchesConvention(segment) {
+    return (segment === "index" ||
+        matchDynamicName(segment) != null ||
+        matchFragmentName(segment) != null ||
+        matchDeepDynamicRouteName(segment) != null);
+}
+function encodeURIComponentPreservingBrackets(str) {
+    return encodeURIComponent(str).replace(/%5B/g, "[").replace(/%5D/g, "]");
+}
 /**
  * Utility to serialize a navigation state object to a path string.
  *
@@ -59,175 +68,294 @@ function createFakeState(params) {
  * @param options Extra options to fine-tune how to serialize the path.
  * @returns Path representing the state, e.g. /foo/bar?count=42.
  */
-export default function getPathFromState(state, options) {
+export default function getPathFromState(state, 
+// @ts-expect-error: non-standard options
+_options = {}) {
     if (state == null) {
         throw Error("Got 'undefined' for the navigation state. You must pass a valid state object.");
     }
-    if (options) {
+    const { preserveFragments, preserveDynamicRoutes, ...options } = _options;
+    if (_options) {
         validatePathConfig(options);
     }
+    const screens = options?.screens;
+    // Expo Router disallows usage without a linking config.
+    if (!screens) {
+        throw Error("You must pass a 'screens' object to 'getPathFromState' to generate a path.");
+    }
+    return getPathFromResolvedState(state, 
     // Create a normalized configs object which will be easier to use
-    const configs = options?.screens
-        ? createNormalizedConfigs(options?.screens)
-        : {};
-    let path = "/";
-    let current = state;
-    const allParams = {};
-    while (current) {
-        let index = typeof current.index === "number" ? current.index : 0;
-        let route = current.routes[index];
-        // NOTE(EvanBacon): Fill in current route using state that was passed as params.
+    createNormalizedConfigs(screens), { preserveFragments, preserveDynamicRoutes });
+}
+function processParamsWithUserSettings(configItem, params) {
+    const stringify = configItem?.stringify;
+    return Object.fromEntries(Object.entries(params).map(([key, value]) => [
+        key,
+        // TODO: Strip nullish values here.
+        stringify?.[key] ? stringify[key](value) : String(value),
+    ]));
+}
+function deepEqual(a, b) {
+    if (a === b) {
+        return true;
+    }
+    if (Array.isArray(a) && Array.isArray(b)) {
+        if (a.length !== b.length) {
+            return false;
+        }
+        for (let i = 0; i < a.length; i++) {
+            if (!deepEqual(a[i], b[i])) {
+                return false;
+            }
+        }
+        return true;
+    }
+    if (typeof a === "object" && typeof b === "object") {
+        const keysA = Object.keys(a);
+        const keysB = Object.keys(b);
+        if (keysA.length !== keysB.length) {
+            return false;
+        }
+        for (const key of keysA) {
+            if (!deepEqual(a[key], b[key])) {
+                return false;
+            }
+        }
+        return true;
+    }
+    return false;
+}
+function walkConfigItems(route, focusedRoute, configs) {
+    // NOTE(EvanBacon): Fill in current route using state that was passed as params.
+    if (!route.state && isInvalidParams(route.params)) {
+        route.state = createFakeState(route.params);
+    }
+    let pattern = null;
+    let focusedParams;
+    const collectedParams = {};
+    while (route.name in configs) {
+        const configItem = configs[route.name];
+        const inputPattern = configItem.pattern;
+        if (inputPattern == null) {
+            // This should never happen in Expo Router.
+            throw new Error("Unexpected: No pattern found for route " + route.name);
+        }
+        pattern = inputPattern;
+        if (route.params) {
+            const params = processParamsWithUserSettings(configItem, route.params);
+            // TODO: Does this need to be a null check?
+            if (pattern) {
+                Object.assign(collectedParams, params);
+            }
+            if (deepEqual(focusedRoute, route)) {
+                // If this is the focused route, keep the params for later use
+                // We save it here since it's been stringified already
+                focusedParams = getParamsWithConventionsCollapsed({
+                    params,
+                    pattern,
+                    routeName: route.name,
+                });
+            }
+        }
         if (!route.state && isInvalidParams(route.params)) {
             route.state = createFakeState(route.params);
         }
-        let pattern;
-        let focusedParams;
-        const focusedRoute = getActiveRoute(state);
-        let currentOptions = configs;
-        // Keep all the route names that appeared during going deeper in config in case the pattern is resolved to undefined
-        const nestedRouteNames = [];
-        let hasNext = true;
-        while (route.name in currentOptions && hasNext) {
-            pattern = currentOptions[route.name].pattern;
-            // @ts-expect-error
-            nestedRouteNames.push(route.name);
-            if (route.params) {
-                const stringify = currentOptions[route.name]?.stringify;
-                const currentParams = Object.fromEntries(Object.entries(route.params).map(([key, value]) => [
-                    key,
-                    stringify?.[key] ? stringify[key](value) : String(value),
-                ]));
-                if (pattern) {
-                    Object.assign(allParams, currentParams);
-                }
-                if (focusedRoute === route) {
+        // If there is no `screens` property or no nested state, we return pattern
+        if (!configItem.screens || route.state === undefined) {
+            if (configItem.initialRouteName &&
+                configItem.screens &&
+                configItem.initialRouteName in configItem.screens &&
+                configItem.screens[configItem.initialRouteName]?.pattern) {
+                const initialRouteConfig = configItem.screens[configItem.initialRouteName];
+                // NOTE(EvanBacon): Big hack to support initial route changes in tab bars.
+                pattern = initialRouteConfig.pattern;
+                if (focusedParams) {
                     // If this is the focused route, keep the params for later use
                     // We save it here since it's been stringified already
-                    focusedParams = { ...currentParams };
-                    pattern
-                        ?.split("/")
-                        .filter((p) => p.startsWith(":") || p === "*")
-                        // eslint-disable-next-line no-loop-func
-                        .forEach((p) => {
-                        let name;
-                        if (p === "*") {
-                            // NOTE(EvanBacon): Drop the param name matching the wildcard route name -- this is specific to Expo Router.
-                            name = matchDeepDynamicRouteName(route.name) ?? route.name;
-                        }
-                        else {
-                            name = getParamName(p);
-                        }
-                        // Remove the params present in the pattern since we'll only use the rest for query string
-                        if (focusedParams) {
-                            // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-                            delete focusedParams[name];
-                        }
+                    focusedParams = getParamsWithConventionsCollapsed({
+                        params: focusedParams,
+                        pattern,
+                        routeName: route.name,
                     });
                 }
             }
-            // If there is no `screens` property or no nested state, we return pattern
-            if (!currentOptions[route.name].screens || route.state === undefined) {
-                hasNext = false;
-            }
-            else {
-                index =
-                    typeof route.state.index === "number"
-                        ? route.state.index
-                        : route.state.routes.length - 1;
-                const nextRoute = route.state.routes[index];
-                const nestedConfig = currentOptions[route.name].screens;
-                // if there is config for next route name, we go deeper
-                if (nestedConfig && nextRoute.name in nestedConfig) {
-                    route = nextRoute;
-                    currentOptions = nestedConfig;
-                }
-                else {
-                    // If not, there is no sense in going deeper in config
-                    hasNext = false;
-                }
-            }
+            break;
         }
-        if (pattern === undefined) {
-            pattern = nestedRouteNames.join("/");
+        const index = route.state.index ?? route.state.routes.length - 1;
+        const nextRoute = route.state.routes[index];
+        const nestedScreens = configItem.screens;
+        // if there is config for next route name, we go deeper
+        if (nestedScreens && nextRoute.name in nestedScreens) {
+            route = nextRoute;
+            configs = nestedScreens;
         }
-        if (currentOptions[route.name] !== undefined) {
-            path += pattern
-                .split("/")
-                .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 === "*") {
-                    if (i === 0) {
-                        // This can occur when a wildcard matches all routes and the given path was `/`.
-                        return route.path ?? "";
+        else {
+            // If not, there is no sense in going deeper in config
+            break;
+        }
+    }
+    if (pattern && !focusedParams && focusedRoute.params) {
+        // If this is the focused route, keep the params for later use
+        // We save it here since it's been stringified already
+        focusedParams = getParamsWithConventionsCollapsed({
+            params: focusedRoute.params,
+            pattern,
+            routeName: route.name,
+        });
+        Object.assign(focusedParams, collectedParams);
+    }
+    if (pattern == null) {
+        throw new Error(`No pattern found for route "${route.name}". Options are: ${Object.keys(configs).join(", ")}.`);
+    }
+    return {
+        pattern,
+        nextRoute: route,
+        focusedParams,
+        params: collectedParams,
+    };
+}
+function getPathFromResolvedState(state, configs, { preserveFragments, preserveDynamicRoutes, }) {
+    let path = "";
+    let current = state;
+    const allParams = {};
+    while (current) {
+        path += "/";
+        const route = current.routes[current.index ?? 0];
+        // NOTE(EvanBacon): Fill in current route using state that was passed as params.
+        // if (isInvalidParams(route.params)) {
+        if (!route.state && isInvalidParams(route.params)) {
+            route.state = createFakeState(route.params);
+        }
+        const { pattern, params, nextRoute, focusedParams } = walkConfigItems(route, getActiveRoute(current), { ...configs });
+        Object.assign(allParams, params);
+        path += getPathWithConventionsCollapsed({
+            pattern,
+            routePath: nextRoute.path,
+            params: allParams,
+            initialRouteName: configs[nextRoute.name]?.initialRouteName,
+            preserveFragments,
+            preserveDynamicRoutes,
+        });
+        if (nextRoute.state) {
+            // Continue looping with the next state if available.
+            current = nextRoute.state;
+        }
+        else {
+            // Finished crawling state.
+            // Check for query params before exiting.
+            if (focusedParams) {
+                for (const param in focusedParams) {
+                    // TODO: This is not good. We shouldn't squat strings named "undefined".
+                    if (focusedParams[param] === "undefined") {
+                        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+                        delete focusedParams[param];
                     }
-                    // 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.
-                    const path = route.path
-                        ?.split("/")
-                        .slice(i + 1)
-                        .join("/");
-                    return path ?? "";
                 }
-                // If the path has a pattern for a param, put the param in the path
-                if (p.startsWith(":")) {
-                    const value = allParams[name];
-                    if (value == null) {
-                        // Optional params without value assigned in route.params should be ignored
-                        return "";
-                    }
-                    return value;
+                const query = queryString.stringify(focusedParams, { sort: false });
+                if (query) {
+                    path += `?${query}`;
                 }
-                return encodeURIComponent(p);
-            })
-                .join("/");
-        }
-        else {
-            // TODO: Probably fragment routes shouldn't get this far
-            path += encodeURIComponent(matchFragmentName(route.name)
-                ? ""
-                : route.name === "index"
-                    ? ""
-                    : route.name);
+            }
+            break;
         }
-        if (!focusedParams) {
-            focusedParams = focusedRoute.params;
+    }
+    return basicSanitizePath(path);
+}
+function getPathWithConventionsCollapsed({ pattern, routePath, params, preserveFragments, preserveDynamicRoutes, initialRouteName, }) {
+    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 === "*") {
+            if (i === 0) {
+                // This can occur when a wildcard matches all routes and the given path was `/`.
+                return routePath;
+            }
+            // 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 routePath
+                ?.split("/")
+                .slice(i + 1)
+                .join("/");
         }
-        if (route.state) {
-            path += "/";
+        // 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
+            return params[name];
         }
-        else if (focusedParams) {
-            for (const param in focusedParams) {
-                if (focusedParams[param] === "undefined") {
-                    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-                    delete focusedParams[param];
+        if (!preserveFragments && matchFragmentName(p) != null) {
+            // When the last part is a fragment 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 encodeURIComponentPreservingBrackets(initialRouteName);
                 }
             }
-            const query = queryString.stringify(focusedParams, { sort: false });
-            if (query) {
-                path += `?${query}`;
-            }
+            return "";
         }
-        current = route.state;
+        // Preserve dynamic syntax for rehydration
+        return encodeURIComponentPreservingBrackets(p);
+    })
+        .map((v) => v ?? "")
+        .join("/");
+}
+/** Given a set of query params and a pattern with possible conventions, collapse the conventions and return the remaining params. */
+function getParamsWithConventionsCollapsed({ pattern, routeName, params, }) {
+    const processedParams = { ...params };
+    // Remove the params present in the pattern since we'll only use the rest for query string
+    const segments = pattern.split("/");
+    // Dynamic Routes
+    segments
+        .filter((segment) => segment.startsWith(":"))
+        .forEach((segment) => {
+        const name = getParamName(segment);
+        delete processedParams[name];
+    });
+    // Deep Dynamic Routes
+    if (segments.some((segment) => segment === "*")) {
+        // NOTE(EvanBacon): Drop the param name matching the wildcard route name -- this is specific to Expo Router.
+        const name = matchDeepDynamicRouteName(routeName) ?? routeName;
+        delete processedParams[name];
     }
-    // Remove multiple as well as trailing slashes
-    path = path.replace(/\/+/g, "/");
-    path = path.length > 1 ? path.replace(/\/$/, "") : path;
-    return path;
+    return processedParams;
+}
+// Remove multiple as well as trailing slashes
+function basicSanitizePath(path) {
+    // Remove duplicate slashes like `foo//bar` -> `foo/bar`
+    const simplifiedPath = path.replace(/\/+/g, "/");
+    if (simplifiedPath.length <= 1) {
+        return simplifiedPath;
+    }
+    // Remove trailing slash like `foo/bar/` -> `foo/bar`
+    return simplifiedPath.replace(/\/$/, "");
 }
 // TODO: Make StackRouter not do this...
 // Detect if the params came from StackRouter using `params` to pass around internal state.
 function isInvalidParams(params) {
-    return (!!params &&
-        "initial" in params &&
-        "path" in params &&
-        "screen" in params &&
-        "params" in params &&
+    if (!params) {
+        return false;
+    }
+    if ("params" in params &&
         typeof params.params === "object" &&
-        !!params.params);
+        !!params.params) {
+        return true;
+    }
+    return ("initial" in params &&
+        typeof params.initial === "boolean" &&
+        // "path" in params &&
+        "screen" in params);
 }
 const getParamName = (pattern) => pattern.replace(/^:/, "").replace(/\?$/, "");
 const joinPaths = (...paths) => []
@@ -256,10 +384,11 @@ const createConfigItem = (config, parentPattern) => {
         pattern: pattern?.split("/").filter(Boolean).join("/"),
         stringify: config.stringify,
         screens,
+        initialRouteName: config.initialRouteName,
     };
 };
-const createNormalizedConfigs = (options, pattern) => Object.fromEntries(Object.entries(options).map(([name, c]) => {
-    const result = createConfigItem(c, pattern);
-    return [name, result];
-}));
+const createNormalizedConfigs = (options, pattern) => Object.fromEntries(Object.entries(options).map(([name, c]) => [
+    name,
+    createConfigItem(c, pattern),
+]));
 //# sourceMappingURL=getPathFromState.js.map