@tanstack/router-generator 1.55.0 → 1.56.1

package/src/generator.ts

@@ -392,13 +392,29 @@ export const Route = createAPIFileRoute('${escapedRoutePath}')({
 
       if (node.children?.length) {
         const childConfigs = buildRouteTreeConfig(node.children, depth + 1)
-        return `${route}: ${route}.addChildren({${spaces(depth * 4)}${childConfigs}})`
+
+        const childrenDeclaration = `interface ${route}Children {
+          ${node.children.map((child) => `${child.variableName}Route: typeof ${getResolvedRouteNodeVariableName(child)}`).join(',')}
+        }`
+
+        const children = `const ${route}Children: ${route}Children = {
+          ${node.children.map((child) => `${child.variableName}Route: ${getResolvedRouteNodeVariableName(child)}`).join(',')}
+        }`
+
+        const routeWithChildren = `const ${route}WithChildren = ${route}._addFileChildren(${route}Children)`
+
+        return [
+          childConfigs,
+          childrenDeclaration,
+          children,
+          routeWithChildren,
+        ].join('\n\n')
       }
 
-      return route
+      return undefined
     })
 
-    return children.filter(Boolean).join(`,`)
+    return children.filter(Boolean).join('\n\n')
   }
 
   const routeConfigChildrenText = buildRouteTreeConfig(routeTree)
@@ -572,7 +588,43 @@ export const Route = createAPIFileRoute('${escapedRoutePath}')({
 }`,
         ]),
     '// Create and export the route tree',
-    `export const routeTree = rootRoute.addChildren({${routeConfigChildrenText}})`,
+    routeConfigChildrenText,
+    `interface FileRoutesByFullPath {
+        ${[...createRouteNodesByFullPath(routeNodes).entries()].map(
+          ([fullPath, routeNode]) => {
+            return `'${fullPath}': typeof ${getResolvedRouteNodeVariableName(routeNode)}`
+          },
+        )}
+  }`,
+    `interface FileRoutesByTo {
+      ${[...createRouteNodesByTo(routeNodes).entries()].map(
+        ([to, routeNode]) => {
+          return `'${to}': typeof ${getResolvedRouteNodeVariableName(routeNode)}`
+        },
+      )}
+    }`,
+    `interface FileRoutesById {
+      ${[...createRouteNodesById(routeNodes).entries()].map(
+        ([id, routeNode]) => {
+          return `'${id}': typeof ${getResolvedRouteNodeVariableName(routeNode)}`
+        },
+      )}
+    }`,
+    `interface FileRouteTypes {
+    fileRoutesByFullPath: FileRoutesByFullPath
+    fullPaths: ${[...createRouteNodesByFullPath(routeNodes).keys()].map((fullPath) => `'${fullPath}'`).join('|')}
+    fileRoutesByTo: FileRoutesByTo
+    to: ${[...createRouteNodesByTo(routeNodes).keys()].map((to) => `'${to}'`).join('|')}
+    id: ${[...createRouteNodesById(routeNodes).keys()].map((id) => `'${id}'`).join('|')}
+    fileRoutesById: FileRoutesById
+    }`,
+    `interface RootRouteChildren {
+      ${routeTree.map((child) => `${child.variableName}Route: typeof ${getResolvedRouteNodeVariableName(child)}`).join(',')}
+    }`,
+    `const rootRouteChildren: RootRouteChildren = {
+      ${routeTree.map((child) => `${child.variableName}Route: ${getResolvedRouteNodeVariableName(child)}`).join(',')}
+    }`,
+    `export const routeTree = rootRoute._addFileChildren(rootRouteChildren)._addFileTypes<FileRouteTypes>()`,
     ...config.routeTreeFileFooter,
   ]
     .filter(Boolean)
@@ -752,6 +804,56 @@ export function hasParentRoute(
   return hasParentRoute(routes, node, parentRoutePath)
 }
 
+/**
+ * Gets the final variable name for a route
+ */
+export const getResolvedRouteNodeVariableName = (
+  routeNode: RouteNode,
+): string => {
+  return routeNode.children?.length
+    ? `${routeNode.variableName}RouteWithChildren`
+    : `${routeNode.variableName}Route`
+}
+
+/**
+ * Creates a map from fullPath to routeNode
+ */
+export const createRouteNodesByFullPath = (
+  routeNodes: Array<RouteNode>,
+): Map<string, RouteNode> => {
+  return new Map(
+    routeNodes.map((routeNode) => [inferFullPath(routeNode), routeNode]),
+  )
+}
+
+/**
+ * Create a map from 'to' to a routeNode
+ */
+export const createRouteNodesByTo = (
+  routeNodes: Array<RouteNode>,
+): Map<string, RouteNode> => {
+  return new Map(
+    dedupeBranchesAndIndexRoutes(routeNodes).map((routeNode) => [
+      inferTo(routeNode),
+      routeNode,
+    ]),
+  )
+}
+
+/**
+ * Create a map from 'id' to a routeNode
+ */
+export const createRouteNodesById = (
+  routeNodes: Array<RouteNode>,
+): Map<string, RouteNode> => {
+  return new Map(
+    routeNodes.map((routeNode) => {
+      const [_, id] = getFilePathIdAndRouteIdFromPath(routeNode.routePath)
+      return [id, routeNode]
+    }),
+  )
+}
+
 /**
  * Infers the full path for use by TS
  */
@@ -772,6 +874,29 @@ export const inferPath = (routeNode: RouteNode): string => {
     : (routeNode.cleanedPath?.replace(/\/$/, '') ?? '')
 }
 
+/**
+ * Infers to path
+ */
+export const inferTo = (routeNode: RouteNode): string => {
+  const fullPath = inferFullPath(routeNode)
+
+  if (fullPath === '/') return fullPath
+
+  return fullPath.replace(/\/$/, '')
+}
+
+/**
+ * Dedupes branches and index routes
+ */
+export const dedupeBranchesAndIndexRoutes = (
+  routes: Array<RouteNode>,
+): Array<RouteNode> => {
+  return routes.filter((route) => {
+    if (route.children?.find((child) => child.cleanedPath === '/')) return false
+    return true
+  })
+}
+
 function getFilePathIdAndRouteIdFromPath(pathname?: string) {
   const filePathId = removeTrailingUnderscores(pathname)
   const id = removeGroups(filePathId ?? '')