@tanstack/start-plugin-core 1.121.0-alpha.26 → 1.121.0-alpha.28

package/dist/esm/plugin.d.ts

@@ -1,291 +1,16 @@
-import { createTanStackStartOptionsSchema } from './schema.js';
+import { TanStackStartInputConfig } from './schema.js';
 import { PluginOption } from 'vite';
-import { z } from 'zod';
 import { CompileStartFrameworkOptions } from './compilers.js';
-export type TanStackStartInputConfig = z.input<ReturnType<typeof createTanStackStartOptionsSchema>>;
-export declare function getTanStackStartOptions(opts?: TanStackStartInputConfig): {
-    tsr: {
-        target: "react" | "solid";
-        routeFileIgnorePrefix: string;
-        routesDirectory: string;
-        quoteStyle: "single" | "double";
-        semicolons: boolean;
-        disableLogging: boolean;
-        routeTreeFileHeader: string[];
-        indexToken: string;
-        routeToken: string;
-        generatedRouteTree: string;
-        disableTypes: boolean;
-        addExtensions: boolean;
-        enableRouteTreeFormatting: boolean;
-        routeTreeFileFooter: string[];
-        tmpDir: string;
-        virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
-        routeFilePrefix?: string | undefined;
-        routeFileIgnorePattern?: string | undefined;
-        pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
-        verboseFileRoutes?: boolean | undefined;
-        autoCodeSplitting?: boolean | undefined;
-        customScaffolding?: {
-            routeTemplate?: string | undefined;
-            lazyRouteTemplate?: string | undefined;
-        } | undefined;
-        experimental?: {
-            enableCodeSplitting?: boolean | undefined;
-        } | undefined;
-        plugins?: import('@tanstack/router-generator').GeneratorPlugin[] | undefined;
-        srcDirectory: string;
-    };
-    clientEntryPath: string;
-    serverEntryPath: string;
-    root: string;
-    client: {
-        base: string;
-        entry?: string | undefined;
-    };
-    server: {
-        entry?: string | undefined;
-    };
-    serverFns: {
-        base: string;
-    };
-    public: {
-        base: string;
-        dir: string;
-    };
-    pages: {
-        path: string;
-        prerender?: {
-            enabled?: boolean | undefined;
-            outputPath?: string | undefined;
-            autoSubfolderIndex?: boolean | undefined;
-            crawlLinks?: boolean | undefined;
-            retryCount?: number | undefined;
-            retryDelay?: number | undefined;
-            onSuccess?: ((args_0: {
-                page: {
-                    path: string;
-                    sitemap?: {
-                        exclude?: boolean | undefined;
-                        priority?: number | undefined;
-                        changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never" | undefined;
-                        lastmod?: string | Date | undefined;
-                        alternateRefs?: {
-                            href: string;
-                            hreflang: string;
-                        }[] | undefined;
-                        images?: {
-                            loc: string;
-                            caption?: string | undefined;
-                            title?: string | undefined;
-                        }[] | undefined;
-                        news?: {
-                            title: string;
-                            publication: {
-                                name: string;
-                                language: string;
-                            };
-                            publicationDate: string | Date;
-                        } | undefined;
-                    } | undefined;
-                    fromCrawl?: boolean | undefined;
-                };
-                html: string;
-            }, ...args: unknown[]) => any) | undefined;
-        } | undefined;
-        sitemap?: {
-            exclude?: boolean | undefined;
-            priority?: number | undefined;
-            changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never" | undefined;
-            lastmod?: string | Date | undefined;
-            alternateRefs?: {
-                href: string;
-                hreflang: string;
-            }[] | undefined;
-            images?: {
-                loc: string;
-                caption?: string | undefined;
-                title?: string | undefined;
-            }[] | undefined;
-            news?: {
-                title: string;
-                publication: {
-                    name: string;
-                    language: string;
-                };
-                publicationDate: string | Date;
-            } | undefined;
-        } | undefined;
-        fromCrawl?: boolean | undefined;
-    }[];
-    target?: import('nitropack/presets').PresetNameInput | undefined;
-    prerender?: ({
-        filter?: ((args_0: {
-            path: string;
-            prerender?: {
-                enabled?: boolean | undefined;
-                outputPath?: string | undefined;
-                autoSubfolderIndex?: boolean | undefined;
-                crawlLinks?: boolean | undefined;
-                retryCount?: number | undefined;
-                retryDelay?: number | undefined;
-                onSuccess?: ((args_0: {
-                    page: {
-                        path: string;
-                        sitemap?: {
-                            exclude?: boolean | undefined;
-                            priority?: number | undefined;
-                            changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never" | undefined;
-                            lastmod?: string | Date | undefined;
-                            alternateRefs?: {
-                                href: string;
-                                hreflang: string;
-                            }[] | undefined;
-                            images?: {
-                                loc: string;
-                                caption?: string | undefined;
-                                title?: string | undefined;
-                            }[] | undefined;
-                            news?: {
-                                title: string;
-                                publication: {
-                                    name: string;
-                                    language: string;
-                                };
-                                publicationDate: string | Date;
-                            } | undefined;
-                        } | undefined;
-                        fromCrawl?: boolean | undefined;
-                    };
-                    html: string;
-                }, ...args: unknown[]) => any) | undefined;
-            } | undefined;
-            sitemap?: {
-                exclude?: boolean | undefined;
-                priority?: number | undefined;
-                changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never" | undefined;
-                lastmod?: string | Date | undefined;
-                alternateRefs?: {
-                    href: string;
-                    hreflang: string;
-                }[] | undefined;
-                images?: {
-                    loc: string;
-                    caption?: string | undefined;
-                    title?: string | undefined;
-                }[] | undefined;
-                news?: {
-                    title: string;
-                    publication: {
-                        name: string;
-                        language: string;
-                    };
-                    publicationDate: string | Date;
-                } | undefined;
-            } | undefined;
-            fromCrawl?: boolean | undefined;
-        }, ...args: unknown[]) => any) | undefined;
-        enabled?: boolean | undefined;
-        concurrency?: number | undefined;
-        failOnError?: boolean | undefined;
-    } & {
-        enabled?: boolean | undefined;
-        outputPath?: string | undefined;
-        autoSubfolderIndex?: boolean | undefined;
-        crawlLinks?: boolean | undefined;
-        retryCount?: number | undefined;
-        retryDelay?: number | undefined;
-        onSuccess?: ((args_0: {
-            page: {
-                path: string;
-                sitemap?: {
-                    exclude?: boolean | undefined;
-                    priority?: number | undefined;
-                    changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never" | undefined;
-                    lastmod?: string | Date | undefined;
-                    alternateRefs?: {
-                        href: string;
-                        hreflang: string;
-                    }[] | undefined;
-                    images?: {
-                        loc: string;
-                        caption?: string | undefined;
-                        title?: string | undefined;
-                    }[] | undefined;
-                    news?: {
-                        title: string;
-                        publication: {
-                            name: string;
-                            language: string;
-                        };
-                        publicationDate: string | Date;
-                    } | undefined;
-                } | undefined;
-                fromCrawl?: boolean | undefined;
-            };
-            html: string;
-        }, ...args: unknown[]) => any) | undefined;
-    }) | undefined;
-    sitemap?: {
-        enabled: boolean;
-        outputPath: string;
-        host?: string | undefined;
-    } | undefined;
-    spa?: {
-        prerender: {
-            enabled: boolean;
-            outputPath: string;
-            autoSubfolderIndex?: boolean | undefined;
-            crawlLinks: boolean;
-            retryCount: number;
-            retryDelay?: number | undefined;
-            onSuccess?: ((args_0: {
-                page: {
-                    path: string;
-                    sitemap?: {
-                        exclude?: boolean | undefined;
-                        priority?: number | undefined;
-                        changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never" | undefined;
-                        lastmod?: string | Date | undefined;
-                        alternateRefs?: {
-                            href: string;
-                            hreflang: string;
-                        }[] | undefined;
-                        images?: {
-                            loc: string;
-                            caption?: string | undefined;
-                            title?: string | undefined;
-                        }[] | undefined;
-                        news?: {
-                            title: string;
-                            publication: {
-                                name: string;
-                                language: string;
-                            };
-                            publicationDate: string | Date;
-                        } | undefined;
-                    } | undefined;
-                    fromCrawl?: boolean | undefined;
-                };
-                html: string;
-            }, ...args: unknown[]) => any) | undefined;
-        };
-        enabled: boolean;
-        maskPath: string;
-    } | undefined;
-};
-export type TanStackStartOutputConfig = ReturnType<typeof getTanStackStartOptions>;
 export interface TanStackStartVitePluginCoreOptions {
     framework: CompileStartFrameworkOptions;
-    getVirtualServerRootHandler: (ctx: {
-        routerFilepath: string;
-        serverEntryFilepath: string;
-    }) => string;
-    getVirtualServerEntry: (ctx: {
-        routerFilepath: string;
-    }) => string;
-    getVirtualClientEntry: (ctx: {
-        routerFilepath: string;
-    }) => string;
+    defaultEntryPaths: {
+        client: string;
+        server: string;
+    };
+    crawlPackages?: (opts: {
+        name: string;
+        peerDependencies: Record<string, any>;
+        exports?: Record<string, any> | string;
+    }) => 'include' | 'exclude' | undefined;
 }
-export declare function TanStackStartVitePluginCore(opts: TanStackStartVitePluginCoreOptions, startConfig: TanStackStartOutputConfig): Array<PluginOption>;
+export declare function TanStackStartVitePluginCore(corePluginOpts: TanStackStartVitePluginCoreOptions, startPluginOpts: TanStackStartInputConfig): Array<PluginOption>;

package/dist/esm/plugin.js

@@ -1,135 +1,211 @@
 import path from "node:path";
-import { createNitro } from "nitropack";
 import { trimPathRight } from "@tanstack/router-core";
 import { VIRTUAL_MODULES } from "@tanstack/start-server-core";
 import { TanStackServerFnPluginEnv } from "@tanstack/server-functions-plugin";
 import * as vite from "vite";
-import { createTanStackConfig } from "./schema.js";
-import { nitroPlugin } from "./nitro-plugin/plugin.js";
+import { crawlFrameworkPkgs } from "vitefu";
+import { join } from "pathe";
 import { startManifestPlugin } from "./start-manifest-plugin/plugin.js";
 import { startCompilerPlugin } from "./start-compiler-plugin.js";
-import { SSR_ENTRY_FILE, VITE_ENVIRONMENT_NAMES, CLIENT_DIST_DIR } from "./constants.js";
+import { ENTRY_POINTS, VITE_ENVIRONMENT_NAMES } from "./constants.js";
 import { tanStackStartRouter } from "./start-router-plugin/plugin.js";
 import { loadEnvPlugin } from "./load-env-plugin/plugin.js";
 import { devServerPlugin } from "./dev-server-plugin/plugin.js";
-import { resolveVirtualEntriesPlugin } from "./resolve-virtual-entries-plugin/plugin.js";
-createTanStackConfig();
-let ssrBundle;
-function TanStackStartVitePluginCore(opts, startConfig) {
+import { parseStartConfig } from "./schema.js";
+import { resolveEntry } from "./resolve-entries.js";
+import { getServerOutputDirectory, getClientOutputDirectory } from "./output-directory.js";
+import { postServerBuild } from "./post-server-build.js";
+function TanStackStartVitePluginCore(corePluginOpts, startPluginOpts) {
+  const startConfig = parseStartConfig(startPluginOpts);
+  const capturedBundle = {};
+  function getBundle(envName) {
+    const bundle = capturedBundle[envName];
+    if (!bundle) {
+      throw new Error(`No bundle captured for environment: ${envName}`);
+    }
+    return bundle;
+  }
   return [
     tanStackStartRouter({
       ...startConfig.tsr,
-      target: opts.framework,
+      target: corePluginOpts.framework,
       autoCodeSplitting: true
     }),
-    resolveVirtualEntriesPlugin(opts, startConfig),
     {
-      name: "tanstack-start-core:config-client",
-      async config(viteConfig) {
+      name: "tanstack-start-core:config",
+      async config(viteConfig, { command }) {
         const viteAppBase = trimPathRight(viteConfig.base || "/");
         globalThis.TSS_APP_BASE = viteAppBase;
-        const nitroOutputPublicDir = await (async () => {
-          const dummyNitroApp = await createNitro({
-            preset: startConfig.target,
-            compatibilityDate: "2024-12-01"
-          });
-          const nitroOutputPublicDir2 = dummyNitroApp.options.output.publicDir;
-          await dummyNitroApp.close();
-          return nitroOutputPublicDir2;
-        })();
-        const getClientEntryPath = (startConfig2) => {
-          const entry = startConfig2.clientEntryPath.startsWith(
-            "/~start/default-client-entry"
-          ) ? startConfig2.clientEntryPath : vite.normalizePath(
-            path.join(
-              "/@fs",
-              path.resolve(startConfig2.root, startConfig2.clientEntryPath)
-            )
+        const root = viteConfig.root || process.cwd();
+        const resolvedSrcDirectory = join(root, startConfig.tsr.srcDirectory);
+        const routerFilePath = resolveEntry({
+          type: "router entry",
+          configuredEntry: startConfig.router.entry,
+          defaultEntry: "router",
+          root,
+          resolvedSrcDirectory,
+          required: true
+        });
+        const clientEntryPath = resolveEntry({
+          type: "client entry",
+          configuredEntry: startConfig.client.entry,
+          defaultEntry: "client",
+          root,
+          resolvedSrcDirectory,
+          required: false
+        });
+        const serverEntryPath = resolveEntry({
+          type: "server entry",
+          configuredEntry: startConfig.server.entry,
+          defaultEntry: "server",
+          root,
+          resolvedSrcDirectory,
+          required: false
+        });
+        let clientAlias;
+        if (clientEntryPath) {
+          clientAlias = vite.normalizePath(
+            path.join("/@fs", path.resolve(root, clientEntryPath))
           );
-          return entry;
+        } else {
+          clientAlias = corePluginOpts.defaultEntryPaths.client;
+        }
+        let serverAlias;
+        if (serverEntryPath) {
+          serverAlias = vite.normalizePath(path.resolve(root, serverEntryPath));
+        } else {
+          serverAlias = corePluginOpts.defaultEntryPaths.server;
+        }
+        const entryAliasConfiguration = {
+          [ENTRY_POINTS.router]: routerFilePath,
+          [ENTRY_POINTS.client]: clientAlias,
+          [ENTRY_POINTS.server]: serverAlias
+        };
+        const startPackageName = `@tanstack/${corePluginOpts.framework}-start`;
+        const routerPackageName = `@tanstack/${corePluginOpts.framework}-router`;
+        const additionalOptimizeDeps = {
+          include: /* @__PURE__ */ new Set(),
+          exclude: /* @__PURE__ */ new Set()
         };
+        const result = await crawlFrameworkPkgs({
+          root: process.cwd(),
+          isBuild: command === "build",
+          isFrameworkPkgByJson(pkgJson) {
+            if ([routerPackageName, startPackageName].includes(pkgJson.name)) {
+              return false;
+            }
+            const peerDependencies = pkgJson["peerDependencies"];
+            if (peerDependencies) {
+              const internalResult = corePluginOpts.crawlPackages?.({
+                name: pkgJson.name,
+                peerDependencies,
+                exports: pkgJson.exports
+              });
+              if (internalResult) {
+                if (internalResult === "exclude") {
+                  additionalOptimizeDeps.exclude.add(pkgJson.name);
+                } else {
+                  additionalOptimizeDeps.include.add(pkgJson.name);
+                }
+              }
+              return startPackageName in peerDependencies || routerPackageName in peerDependencies;
+            }
+            return false;
+          }
+        });
         return {
           base: viteAppBase,
+          // see https://vite.dev/config/shared-options.html#apptype
+          // this will prevent vite from injecting middlewares that we don't want
+          appType: viteConfig.appType ?? "custom",
           environments: {
             [VITE_ENVIRONMENT_NAMES.client]: {
               consumer: "client",
               build: {
-                manifest: true,
+                emptyOutDir: viteConfig.environments?.[VITE_ENVIRONMENT_NAMES.client]?.build?.emptyOutDir ?? true,
                 rollupOptions: {
                   input: {
-                    main: getClientEntryPath(startConfig)
-                  },
-                  output: {
-                    dir: path.resolve(startConfig.root, CLIENT_DIST_DIR)
-                  },
-                  // TODO: this should be removed
-                  external: ["node:fs", "node:path", "node:os", "node:crypto"]
-                }
+                    main: ENTRY_POINTS.client
+                  }
+                },
+                outDir: getClientOutputDirectory(viteConfig)
               }
             },
             [VITE_ENVIRONMENT_NAMES.server]: {
               consumer: "server",
               build: {
+                emptyOutDir: viteConfig.environments?.[VITE_ENVIRONMENT_NAMES.server]?.build?.emptyOutDir ?? false,
                 ssr: true,
-                // we don't write to the file system as the below 'capture-output' plugin will
-                // capture the output and write it to the virtual file system
-                write: false,
-                copyPublicDir: false,
                 rollupOptions: {
-                  output: {
-                    entryFileNames: SSR_ENTRY_FILE
-                  },
-                  plugins: [
-                    {
-                      name: "capture-output",
-                      generateBundle(_options, bundle) {
-                        ssrBundle = bundle;
-                      }
-                    }
-                  ]
+                  input: viteConfig.environments?.[VITE_ENVIRONMENT_NAMES.server]?.build?.rollupOptions?.input ?? ENTRY_POINTS.server
                 },
+                outDir: getServerOutputDirectory(viteConfig),
                 commonjsOptions: {
                   include: [/node_modules/]
-                }
+                },
+                copyPublicDir: viteConfig.environments?.[VITE_ENVIRONMENT_NAMES.server]?.build?.copyPublicDir ?? false
               }
             }
           },
           resolve: {
             noExternal: [
-              "@tanstack/start-client",
-              "@tanstack/start-client-core",
-              "@tanstack/start-server",
-              "@tanstack/start-server-core",
-              "@tanstack/start-server-functions-fetcher",
-              "@tanstack/start-server-functions-client",
-              "@tanstack/start-server-functions-server",
-              "@tanstack/start-router-manifest",
-              "@tanstack/start-config",
-              "@tanstack/server-functions-plugin",
-              "nitropack",
-              "@tanstack/**start**",
-              ...Object.values(VIRTUAL_MODULES)
-            ]
+              "@tanstack/start**",
+              `@tanstack/${corePluginOpts.framework}-start**`,
+              ...Object.values(VIRTUAL_MODULES),
+              startPackageName,
+              ...result.ssr.noExternal.sort()
+            ],
+            dedupe: [startPackageName],
+            alias: {
+              ...entryAliasConfiguration
+            }
           },
           optimizeDeps: {
-            exclude: [...Object.values(VIRTUAL_MODULES)]
+            exclude: [
+              ...Object.values(VIRTUAL_MODULES),
+              startPackageName,
+              ...result.optimizeDeps.exclude.sort(),
+              ...additionalOptimizeDeps.exclude
+            ],
+            include: [...additionalOptimizeDeps.include]
           },
           /* prettier-ignore */
           define: {
             // define is an esbuild function that replaces the any instances of given keys with the given values
             // i.e: __FRAMEWORK_NAME__ can be replaced with JSON.stringify("TanStack Start")
             // This is not the same as injecting environment variables.
-            ...defineReplaceEnv("TSS_CLIENT_ENTRY", getClientEntryPath(startConfig)),
-            // This is consumed by the router-manifest, where the entry point is imported after the dev refresh runtime is resolved
             ...defineReplaceEnv("TSS_SERVER_FN_BASE", startConfig.serverFns.base),
-            ...defineReplaceEnv("TSS_OUTPUT_PUBLIC_DIR", nitroOutputPublicDir),
-            ...defineReplaceEnv("TSS_APP_BASE", viteAppBase)
+            ...defineReplaceEnv("TSS_OUTPUT_PUBLIC_DIR", getClientOutputDirectory(viteConfig)),
+            ...defineReplaceEnv("TSS_APP_BASE", viteAppBase),
+            ...command === "serve" ? defineReplaceEnv("TSS_SHELL", startConfig.spa?.enabled ? "true" : "false") : {},
+            ...defineReplaceEnv("TSS_DEV_SERVER", command === "serve" ? "true" : "false")
+          },
+          builder: {
+            sharedPlugins: true,
+            async buildApp(builder) {
+              const client = builder.environments[VITE_ENVIRONMENT_NAMES.client];
+              const server = builder.environments[VITE_ENVIRONMENT_NAMES.server];
+              if (!client) {
+                throw new Error("Client environment not found");
+              }
+              if (!server) {
+                throw new Error("SSR environment not found");
+              }
+              if (!client.isBuilt) {
+                await builder.build(client);
+              }
+              if (!server.isBuilt) {
+                await builder.build(server);
+              }
+              const serverBundle = getBundle(VITE_ENVIRONMENT_NAMES.server);
+              await postServerBuild({ builder, startConfig, serverBundle });
+            }
           }
         };
       }
     },
     // N.B. TanStackStartCompilerPlugin must be before the TanStackServerFnPluginEnv
-    startCompilerPlugin(opts.framework, {
+    startCompilerPlugin(corePluginOpts.framework, {
       client: { envName: VITE_ENVIRONMENT_NAMES.client },
       server: { envName: VITE_ENVIRONMENT_NAMES.server }
     }),
@@ -137,29 +213,36 @@ function TanStackStartVitePluginCore(opts, startConfig) {
       // This is the ID that will be available to look up and import
       // our server function manifest and resolve its module
       manifestVirtualImportId: VIRTUAL_MODULES.serverFnManifest,
-      manifestOutputFilename: ".tanstack-start/build/server/server-functions-manifest.json",
       client: {
-        getRuntimeCode: () => `import { createClientRpc } from '@tanstack/${opts.framework}-start/server-functions-client'`,
+        getRuntimeCode: () => `import { createClientRpc } from '@tanstack/${corePluginOpts.framework}-start/server-functions-client'`,
         replacer: (d) => `createClientRpc('${d.functionId}', '${startConfig.serverFns.base}')`,
         envName: VITE_ENVIRONMENT_NAMES.client
       },
       server: {
-        getRuntimeCode: () => `import { createServerRpc } from '@tanstack/${opts.framework}-start/server-functions-server'`,
+        getRuntimeCode: () => `import { createServerRpc } from '@tanstack/${corePluginOpts.framework}-start/server-functions-server'`,
         replacer: (d) => `createServerRpc('${d.functionId}', '${startConfig.serverFns.base}', ${d.fn})`,
         envName: VITE_ENVIRONMENT_NAMES.server
+      }
+    }),
+    loadEnvPlugin(),
+    startManifestPlugin({
+      getClientBundle: () => getBundle(VITE_ENVIRONMENT_NAMES.client)
+    }),
+    devServerPlugin({ startConfig }),
+    {
+      name: "tanstack-start:core:capture-bundle",
+      applyToEnvironment(e) {
+        return e.name === VITE_ENVIRONMENT_NAMES.client || e.name === VITE_ENVIRONMENT_NAMES.server;
       },
-      importer: (fn) => {
-        const serverEnv = globalThis.viteDevServer.environments[VITE_ENVIRONMENT_NAMES.server];
-        if (!serverEnv) {
-          throw new Error(`'ssr' vite dev environment not found`);
+      enforce: "post",
+      generateBundle(_options, bundle) {
+        const environment = this.environment.name;
+        if (!Object.values(VITE_ENVIRONMENT_NAMES).includes(environment)) {
+          throw new Error(`Unknown environment: ${environment}`);
         }
-        return serverEnv.runner.import(fn.extractedFilename);
+        capturedBundle[environment] = bundle;
       }
-    }),
-    loadEnvPlugin(startConfig),
-    startManifestPlugin(startConfig),
-    devServerPlugin(),
-    nitroPlugin(startConfig, () => ssrBundle)
+    }
   ];
 }
 function defineReplaceEnv(key, value) {