@tanstack/router-generator 1.120.4-alpha.4 → 1.120.4

package/dist/esm/generator.js

@@ -1,12 +1,15 @@
 import path from "node:path";
 import * as fs from "node:fs";
 import * as fsp from "node:fs/promises";
-import { logging, multiSortBy, replaceBackslash, removeExt, writeIfDifferent, format, resetRegex, trimPathLeft, removeUnderscores, routePathToVariable } from "./utils.js";
+import { logging, multiSortBy, replaceBackslash, removeExt, writeIfDifferent, format, determineInitialRoutePath, resetRegex, trimPathLeft, removeUnderscores, routePathToVariable, removeTrailingSlash } from "./utils.js";
 import { getRouteNodes as getRouteNodes$1 } from "./filesystem/physical/getRouteNodes.js";
 import { getRouteNodes } from "./filesystem/virtual/getRouteNodes.js";
 import { rootPathId } from "./filesystem/physical/rootPathId.js";
-import { getTargetTemplate, fillTemplate } from "./template.js";
-const rootRouteId = "__root__";
+import { getTargetTemplate, fillTemplate, defaultAPIRouteTemplate } from "./template.js";
+const CONSTANTS = {
+  // When changing this, you'll want to update the import in `start-api-routes/src/index.ts#defaultAPIFileRouteHandler`
+  APIRouteExportVariable: "APIRoute"
+};
 let latestTask = 0;
 const routeGroupPatternRegex = /\(.+\)/g;
 const possiblyNestedRouteGroupPatternRegex = /\([^/]+\)\/?/g;
@@ -35,6 +38,7 @@ async function generator(config, root) {
   };
   const start = Date.now();
   const TYPES_DISABLED = config.disableTypes;
+  const ENABLED_API_ROUTES_GENERATION = config.__enableAPIRoutesGeneration ?? false;
   let getRouteNodesResult;
   if (config.virtualRouteConfig) {
     getRouteNodesResult = await getRouteNodes(config, root);
@@ -70,6 +74,23 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
   ]).filter((d) => ![`/${rootPathId}`].includes(d.routePath || ""));
   const routeTree = [];
   const routePiecesByPath = {};
+  const onlyAPIRouteNodes = preRouteNodes.filter((d) => {
+    if (!ENABLED_API_ROUTES_GENERATION) {
+      return false;
+    }
+    if (d._fsRouteType !== "api") {
+      return false;
+    }
+    return true;
+  });
+  const onlyGeneratorRouteNodes = preRouteNodes.filter((d) => {
+    if (ENABLED_API_ROUTES_GENERATION) {
+      if (d._fsRouteType === "api") {
+        return false;
+      }
+    }
+    return true;
+  });
   const routeNodes = [];
   const handleRootNode = async (node) => {
     if (!node) {
@@ -134,7 +155,7 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
             (((_c = config.customScaffolding) == null ? void 0 : _c.lazyRouteTemplate) || ((_d = config.customScaffolding) == null ? void 0 : _d.routeTemplate)) ?? tLazyRouteTemplate.template(),
             {
               tsrImports: tLazyRouteTemplate.imports.tsrImports(),
-              tsrPath: escapedRoutePath.replaceAll(/\{(.+)\}/gm, "$1"),
+              tsrPath: escapedRoutePath,
               tsrExportStart: tLazyRouteTemplate.imports.tsrExportStart(escapedRoutePath),
               tsrExportEnd: tLazyRouteTemplate.imports.tsrExportEnd()
             }
@@ -155,66 +176,16 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
             ((_e = config.customScaffolding) == null ? void 0 : _e.routeTemplate) ?? tRouteTemplate.template(),
             {
               tsrImports: tRouteTemplate.imports.tsrImports(),
-              tsrPath: escapedRoutePath.replaceAll(/\{(.+)\}/gm, "$1"),
+              tsrPath: escapedRoutePath,
               tsrExportStart: tRouteTemplate.imports.tsrExportStart(escapedRoutePath),
               tsrExportEnd: tRouteTemplate.imports.tsrExportEnd()
             }
           );
         }
-      } else if (config.verboseFileRoutes === false) {
-        if (!routeCode.split("\n").some((line) => line.trim().startsWith("export const Route"))) {
-          return;
-        }
-        replaced = routeCode.replace(
-          /(FileRoute\(\s*['"])([^\s]*)(['"],?\s*\))/g,
-          (_, p1, __, p3) => `${p1}${escapedRoutePath}${p3}`
-        ).replace(
-          new RegExp(
-            `(import\\s*\\{)(.*)(create(Lazy)?FileRoute)(.*)(\\}\\s*from\\s*['"]@tanstack\\/${ROUTE_TEMPLATE.subPkg}['"])`,
-            "gs"
-          ),
-          (_, p1, p2, ___, ____, p5, p6) => {
-            const beforeCreateFileRoute = () => {
-              if (!p2) return "";
-              let trimmed = p2.trim();
-              if (trimmed.endsWith(",")) {
-                trimmed = trimmed.slice(0, -1);
-              }
-              return trimmed;
-            };
-            const afterCreateFileRoute = () => {
-              if (!p5) return "";
-              let trimmed = p5.trim();
-              if (trimmed.startsWith(",")) {
-                trimmed = trimmed.slice(1);
-              }
-              return trimmed;
-            };
-            const newImport = () => {
-              const before = beforeCreateFileRoute();
-              const after = afterCreateFileRoute();
-              if (!before) return after;
-              if (!after) return before;
-              return `${before},${after}`;
-            };
-            const middle = newImport();
-            if (middle === "") return "";
-            return `${p1} ${newImport()} ${p6}`;
-          }
-        ).replace(
-          /create(Lazy)?FileRoute(\(\s*['"])([^\s]*)(['"],?\s*\))/g,
-          (_, __, p2, ___, p4) => `${node._fsRouteType === "lazy" ? "createLazyFileRoute" : "createFileRoute"}`
-        );
       } else {
-        if (!routeCode.split("\n").some((line) => line.trim().startsWith("export const Route"))) {
-          return;
-        }
         replaced = routeCode.replace(
           /(FileRoute\(\s*['"])([^\s]*)(['"],?\s*\))/g,
           (_, p1, __, p3) => `${p1}${escapedRoutePath}${p3}`
-        ).replace(
-          /((FileRoute)(\s*)(\({))/g,
-          (_, __, p2, p3, p4) => `${p2}('${escapedRoutePath}')${p3}${p4}`
         ).replace(
           new RegExp(
             `(import\\s*\\{.*)(create(Lazy)?FileRoute)(.*\\}\\s*from\\s*['"]@tanstack\\/${ROUTE_TEMPLATE.subPkg}['"])`,
@@ -225,16 +196,6 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
           /create(Lazy)?FileRoute(\(\s*['"])([^\s]*)(['"],?\s*\))/g,
           (_, __, p2, ___, p4) => `${node._fsRouteType === "lazy" ? "createLazyFileRoute" : "createFileRoute"}${p2}${escapedRoutePath}${p4}`
         );
-        const regex = new RegExp(
-          `(import\\s*\\{.*)(create(Lazy)?FileRoute)(.*\\}\\s*from\\s*['"]@tanstack\\/${ROUTE_TEMPLATE.subPkg}['"])`,
-          "gm"
-        );
-        if (!replaced.match(regex)) {
-          replaced = [
-            `import { ${node._fsRouteType === "lazy" ? "createLazyFileRoute" : "createFileRoute"} } from '@tanstack/${ROUTE_TEMPLATE.subPkg}'`,
-            ...replaced.split("\n")
-          ].join("\n");
-        }
       }
       await writeIfDifferent(node.fullPath, routeCode, replaced, {
         beforeWrite: () => {
@@ -307,15 +268,68 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
     }
     routeNodes.push(node);
   };
-  for (const node of preRouteNodes) {
+  for (const node of onlyGeneratorRouteNodes) {
     await handleNode(node);
   }
   checkRouteFullPathUniqueness(
     preRouteNodes.filter(
-      (d) => d.children === void 0 && "lazy" !== d._fsRouteType
+      (d) => d.children === void 0 && ["api", "lazy"].every(
+        (type) => type !== d._fsRouteType
+      )
     ),
     config
   );
+  const startAPIRouteNodes = checkStartAPIRoutes(
+    onlyAPIRouteNodes,
+    config
+  );
+  const handleAPINode = async (node) => {
+    var _a, _b;
+    const routeCode = fs.readFileSync(node.fullPath, "utf-8");
+    const escapedRoutePath = ((_a = node.routePath) == null ? void 0 : _a.replaceAll("$", "$$")) ?? "";
+    if (!routeCode) {
+      const replaced = await fillTemplate(
+        config,
+        ((_b = config.customScaffolding) == null ? void 0 : _b.apiTemplate) ?? defaultAPIRouteTemplate,
+        {
+          tsrImports: "import { createAPIFileRoute } from '@tanstack/react-start/api';",
+          tsrPath: escapedRoutePath,
+          tsrExportStart: `export const ${CONSTANTS.APIRouteExportVariable} = createAPIFileRoute('${escapedRoutePath}')(`,
+          tsrExportEnd: ");"
+        }
+      );
+      await writeIfDifferent(
+        node.fullPath,
+        "",
+        // Empty string because the file doesn't exist yet
+        replaced,
+        {
+          beforeWrite: () => {
+            logger.log(`🟡 Creating ${node.fullPath}`);
+          }
+        }
+      );
+    } else {
+      await writeIfDifferent(
+        node.fullPath,
+        routeCode,
+        routeCode.replace(
+          /(createAPIFileRoute\(\s*['"])([^\s]*)(['"],?\s*\))/g,
+          (_, p1, __, p3) => `${p1}${escapedRoutePath}${p3}`
+        ),
+        {
+          beforeWrite: () => {
+            logger.log(`🟡 Updating ${node.fullPath}`);
+          }
+        }
+      );
+    }
+  };
+  if (ENABLED_API_ROUTES_GENERATION) {
+    for (const node of startAPIRouteNodes) {
+      await handleAPINode(node);
+    }
+  }
   function buildRouteTreeConfig(nodes, depth = 1) {
     const children = nodes.map((node) => {
       var _a, _b;
@@ -362,21 +376,6 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
     },
     (d) => d
   ]);
-  const typeImports = Object.entries({
-    // Used for augmentation of regular routes
-    CreateFileRoute: config.verboseFileRoutes === false && sortedRouteNodes.some(
-      (d) => isRouteNodeValidForAugmentation(d) && d._fsRouteType !== "lazy"
-    ),
-    // Used for augmentation of lazy (`.lazy`) routes
-    CreateLazyFileRoute: config.verboseFileRoutes === false && sortedRouteNodes.some(
-      (node) => {
-        var _a;
-        return ((_a = routePiecesByPath[node.routePath]) == null ? void 0 : _a.lazy) && isRouteNodeValidForAugmentation(node);
-      }
-    ),
-    // Used in the process of augmenting the routes
-    FileRoutesByPath: config.verboseFileRoutes === false && sortedRouteNodes.some((d) => isRouteNodeValidForAugmentation(d))
-  }).filter((d) => d[1]).map((d) => d[0]).sort((a, b) => a.localeCompare(b));
   const imports = Object.entries({
     createFileRoute: sortedRouteNodes.some((d) => d.isVirtual),
     lazyFn: sortedRouteNodes.some(
@@ -409,20 +408,18 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
     `// This file was automatically generated by TanStack Router.
 // You should NOT make any changes in this file as it will be overwritten.
 // Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified.`,
-    [
-      imports.length ? `import { ${imports.join(", ")} } from '${ROUTE_TEMPLATE.fullPkg}'` : "",
-      !TYPES_DISABLED && typeImports.length ? `import type { ${typeImports.join(", ")} } from '${ROUTE_TEMPLATE.fullPkg}'` : ""
-    ].filter(Boolean).join("\n"),
+    imports.length ? `import { ${imports.join(", ")} } from '${ROUTE_TEMPLATE.fullPkg}'
+` : "",
     "// Import Routes",
     [
       `import { Route as rootRoute } from './${getImportPath(rootRouteNode)}'`,
       ...sortedRouteNodes.filter((d) => !d.isVirtual).map((node) => {
-        return `import { Route as ${node.variableName}RouteImport } from './${getImportPath(node)}'`;
+        return `import { Route as ${node.variableName}Import } from './${getImportPath(node)}'`;
       })
     ].join("\n"),
     virtualRouteNodes.length ? "// Create Virtual Routes" : "",
     virtualRouteNodes.map((node) => {
-      return `const ${node.variableName}RouteImport = createFileRoute('${node.routePath}')()`;
+      return `const ${node.variableName}Import = createFileRoute('${node.routePath}')()`;
     }).join("\n"),
     "// Create/Update Routes",
     sortedRouteNodes.map((node) => {
@@ -433,54 +430,52 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
       const pendingComponentNode = (_d = routePiecesByPath[node.routePath]) == null ? void 0 : _d.pendingComponent;
       const lazyComponentNode = (_e = routePiecesByPath[node.routePath]) == null ? void 0 : _e.lazy;
       return [
-        [
-          `const ${node.variableName}Route = ${node.variableName}RouteImport.update({
+        `const ${node.variableName}Route = ${node.variableName}Import.update({
           ${[
-            `id: '${node.path}'`,
-            !node.isNonPath ? `path: '${node.cleanedPath}'` : void 0,
-            `getParentRoute: () => ${((_f = node.parent) == null ? void 0 : _f.variableName) ?? "root"}Route`
-          ].filter(Boolean).join(",")}
+          `id: '${node.path}'`,
+          !node.isNonPath ? `path: '${node.cleanedPath}'` : void 0,
+          `getParentRoute: () => ${((_f = node.parent) == null ? void 0 : _f.variableName) ?? "root"}Route`
+        ].filter(Boolean).join(",")}
         }${TYPES_DISABLED ? "" : "as any"})`,
-          loaderNode ? `.updateLoader({ loader: lazyFn(() => import('./${replaceBackslash(
-            removeExt(
-              path.relative(
-                path.dirname(config.generatedRouteTree),
-                path.resolve(config.routesDirectory, loaderNode.filePath)
-              ),
-              config.addExtensions
-            )
-          )}'), 'loader') })` : "",
-          componentNode || errorComponentNode || pendingComponentNode ? `.update({
+        loaderNode ? `.updateLoader({ loader: lazyFn(() => import('./${replaceBackslash(
+          removeExt(
+            path.relative(
+              path.dirname(config.generatedRouteTree),
+              path.resolve(config.routesDirectory, loaderNode.filePath)
+            ),
+            config.addExtensions
+          )
+        )}'), 'loader') })` : "",
+        componentNode || errorComponentNode || pendingComponentNode ? `.update({
               ${[
-            ["component", componentNode],
-            ["errorComponent", errorComponentNode],
-            ["pendingComponent", pendingComponentNode]
-          ].filter((d) => d[1]).map((d) => {
-            return `${d[0]}: lazyRouteComponent(() => import('./${replaceBackslash(
-              removeExt(
-                path.relative(
-                  path.dirname(config.generatedRouteTree),
-                  path.resolve(config.routesDirectory, d[1].filePath)
-                ),
-                config.addExtensions
-              )
-            )}'), '${d[0]}')`;
-          }).join("\n,")}
-            })` : "",
-          lazyComponentNode ? `.lazy(() => import('./${replaceBackslash(
+          ["component", componentNode],
+          ["errorComponent", errorComponentNode],
+          ["pendingComponent", pendingComponentNode]
+        ].filter((d) => d[1]).map((d) => {
+          return `${d[0]}: lazyRouteComponent(() => import('./${replaceBackslash(
             removeExt(
               path.relative(
                 path.dirname(config.generatedRouteTree),
-                path.resolve(
-                  config.routesDirectory,
-                  lazyComponentNode.filePath
-                )
+                path.resolve(config.routesDirectory, d[1].filePath)
               ),
               config.addExtensions
             )
-          )}').then((d) => d.Route))` : ""
-        ].join("")
-      ].join("\n\n");
+          )}'), '${d[0]}')`;
+        }).join("\n,")}
+            })` : "",
+        lazyComponentNode ? `.lazy(() => import('./${replaceBackslash(
+          removeExt(
+            path.relative(
+              path.dirname(config.generatedRouteTree),
+              path.resolve(
+                config.routesDirectory,
+                lazyComponentNode.filePath
+              )
+            ),
+            config.addExtensions
+          )
+        )}').then((d) => d.Route))` : ""
+      ].join("");
     }).join("\n\n"),
     ...TYPES_DISABLED ? [] : [
       "// Populate the FileRoutesByPath interface",
@@ -493,36 +488,13 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
           id: '${filePathId}'
           path: '${inferPath(routeNode)}'
           fullPath: '${inferFullPath(routeNode)}'
-          preLoaderRoute: typeof ${routeNode.variableName}RouteImport
-          parentRoute: typeof ${routeNode.isVirtualParentRequired ? `${(_a = routeNode.parent) == null ? void 0 : _a.variableName}Route` : ((_b = routeNode.parent) == null ? void 0 : _b.variableName) ? `${routeNode.parent.variableName}RouteImport` : "rootRoute"}
+          preLoaderRoute: typeof ${routeNode.variableName}Import
+          parentRoute: typeof ${routeNode.isVirtualParentRequired ? `${(_a = routeNode.parent) == null ? void 0 : _a.variableName}Route` : ((_b = routeNode.parent) == null ? void 0 : _b.variableName) ? `${routeNode.parent.variableName}Import` : "rootRoute"}
         }`;
       }).join("\n")}
   }
 }`
     ],
-    ...TYPES_DISABLED ? [] : config.verboseFileRoutes !== false ? [] : [
-      `// Add type-safety to the createFileRoute function across the route tree`,
-      routeNodes.map((routeNode) => {
-        var _a;
-        function getModuleDeclaration(routeNode2) {
-          if (!isRouteNodeValidForAugmentation(routeNode2)) {
-            return "";
-          }
-          return `declare module './${getImportPath(routeNode2)}' {
-                  const ${routeNode2._fsRouteType === "lazy" ? "createLazyFileRoute" : "createFileRoute"}: ${routeNode2._fsRouteType === "lazy" ? `CreateLazyFileRoute<FileRoutesByPath['${routeNode2.routePath}']['preLoaderRoute']>}` : `CreateFileRoute<
-                  '${routeNode2.routePath}',
-                  FileRoutesByPath['${routeNode2.routePath}']['parentRoute'],
-                  FileRoutesByPath['${routeNode2.routePath}']['id'],
-                  FileRoutesByPath['${routeNode2.routePath}']['path'],
-                  FileRoutesByPath['${routeNode2.routePath}']['fullPath']
-                  >
-                  }`}`;
-        }
-        return getModuleDeclaration(routeNode) + getModuleDeclaration(
-          (_a = routePiecesByPath[routeNode.routePath]) == null ? void 0 : _a.lazy
-        );
-      }).join("\n")
-    ],
     "// Create and export the route tree",
     routeConfigChildrenText,
     ...TYPES_DISABLED ? [] : [
@@ -539,7 +511,7 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
       })}
 }`,
       `export interface FileRoutesById {
-  '${rootRouteId}': typeof rootRoute,
+  '__root__': typeof rootRoute,
   ${[...createRouteNodesById(routeNodes).entries()].map(([id, routeNode]) => {
         return `'${id}': typeof ${getResolvedRouteNodeVariableName(routeNode)}`;
       })}
@@ -549,7 +521,7 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
   fullPaths: ${routeNodes.length > 0 ? [...createRouteNodesByFullPath(routeNodes).keys()].map((fullPath) => `'${fullPath}'`).join("|") : "never"}
   fileRoutesByTo: FileRoutesByTo
   to: ${routeNodes.length > 0 ? [...createRouteNodesByTo(routeNodes).keys()].map((to) => `'${to}'`).join("|") : "never"}
-  id: ${[`'${rootRouteId}'`, ...[...createRouteNodesById(routeNodes).keys()].map((id) => `'${id}'`)].join("|")}
+  id: ${[`'__root__'`, ...[...createRouteNodesById(routeNodes).keys()].map((id) => `'${id}'`)].join("|")}
   fileRoutesById: FileRoutesById
 }`,
       `export interface RootRouteChildren {
@@ -564,7 +536,7 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
   ].filter(Boolean).join("\n\n");
   const createRouteManifest = () => {
     const routesManifest = {
-      [rootRouteId]: {
+      __root__: {
         filePath: rootRouteNode.filePath,
         children: routeTree.map((d) => d.routePath)
       },
@@ -631,12 +603,6 @@ Add the file in: "${config.routesDirectory}/${rootPathId}.${config.disableTypes
 function removeGroups(s) {
   return s.replace(possiblyNestedRouteGroupPatternRegex, "");
 }
-function isRouteNodeValidForAugmentation(routeNode) {
-  if (!routeNode || routeNode.isVirtual) {
-    return false;
-  }
-  return true;
-}
 function determineNodePath(node) {
   var _a;
   return node.path = node.parent ? ((_a = node.routePath) == null ? void 0 : _a.replace(node.parent.routePath ?? "", "")) || "/" : node.routePath;
@@ -737,14 +703,60 @@ function checkRouteFullPathUniqueness(_routes, config) {
   const conflictingFiles = checkUnique(routes, "inferredFullPath");
   if (conflictingFiles !== void 0) {
     const errorMessage = `Conflicting configuration paths were found for the following route${conflictingFiles.length > 1 ? "s" : ""}: ${conflictingFiles.map((p) => `"${p.inferredFullPath}"`).join(", ")}.
-Please ensure each Route has a unique full path.
+Please ensure each route has a unique full path.
+Conflicting files: 
+ ${conflictingFiles.map((d) => path.resolve(config.routesDirectory, d.filePath)).join("\n ")}
+`;
+    throw new Error(errorMessage);
+  }
+}
+function checkStartAPIRoutes(_routes, config) {
+  if (_routes.length === 0) {
+    return [];
+  }
+  const routes = _routes.map((d) => {
+    const routePath = removeTrailingSlash(d.routePath ?? "");
+    return { ...d, routePath };
+  });
+  const conflictingFiles = checkUnique(routes, "routePath");
+  if (conflictingFiles !== void 0) {
+    const errorMessage = `Conflicting configuration paths were found for the following API route${conflictingFiles.length > 1 ? "s" : ""}: ${conflictingFiles.map((p) => `"${p}"`).join(", ")}.
+  Please ensure each API route has a unique route path.
 Conflicting files: 
  ${conflictingFiles.map((d) => path.resolve(config.routesDirectory, d.filePath)).join("\n ")}
 `;
     throw new Error(errorMessage);
   }
+  return routes;
+}
+function startAPIRouteSegmentsFromTSRFilePath(src, config) {
+  const routePath = determineInitialRoutePath(src);
+  const parts = routePath.replaceAll(".", "/").split("/").filter((p) => !!p && p !== config.indexToken);
+  const segments = parts.map((part) => {
+    if (part.startsWith("$")) {
+      if (part === "$") {
+        return { value: part, type: "splat" };
+      }
+      part.replaceAll("$", "");
+      return { value: part, type: "param" };
+    }
+    return { value: part, type: "path" };
+  });
+  return segments;
 }
 export {
-  generator
+  CONSTANTS,
+  createRouteNodesByFullPath,
+  createRouteNodesById,
+  createRouteNodesByTo,
+  dedupeBranchesAndIndexRoutes,
+  generator,
+  getResolvedRouteNodeVariableName,
+  hasParentRoute,
+  inferFullPath,
+  inferPath,
+  inferTo,
+  removeLastSegmentFromPath,
+  startAPIRouteSegmentsFromTSRFilePath
 };
 //# sourceMappingURL=generator.js.map