@tanstack/start-plugin-core 1.121.0-alpha.1 → 1.121.0-alpha.10

package/src/nitro/nitro-plugin.ts

@@ -1,14 +1,20 @@
 import path from 'node:path'
 import { rmSync } from 'node:fs'
-import { build, createNitro } from 'nitropack'
+import * as fsp from 'node:fs/promises'
+import { build, copyPublicAssets, createNitro, prepare } from 'nitropack'
 import { dirname, resolve } from 'pathe'
 import { clientDistDir, ssrEntryFile } from '../plugin'
 import { prerender } from '../prerender'
 import { VITE_ENVIRONMENT_NAMES } from '../constants'
+import { buildSitemap } from '../build-sitemap'
 import { devServerPlugin } from './dev-server-plugin'
-import { buildNitroEnvironment } from './build-nitro'
-import type { EnvironmentOptions, PluginOption, Rollup } from 'vite'
-import type { NitroConfig } from 'nitropack'
+import type {
+  EnvironmentOptions,
+  PluginOption,
+  Rollup,
+  ViteBuilder,
+} from 'vite'
+import type { Nitro, NitroConfig } from 'nitropack'
 import type { TanStackStartOutputConfig } from '../plugin'
 
 export function nitroPlugin(
@@ -87,64 +93,7 @@ export function nitroPlugin(
 
               const nitro = await createNitro(nitroConfig)
 
-              await buildNitroEnvironment(nitro, () => build(nitro))
-
-              // If the user has not set a prerender option, we need to set it to true
-              // if the pages array is not empty and has sub options requiring for prerendering
-              if (options.prerender?.enabled !== false) {
-                options.prerender = {
-                  ...options.prerender,
-                  enabled: options.pages.some((d) =>
-                    typeof d === 'string' ? false : !!d.prerender?.enabled,
-                  ),
-                }
-              }
-
-              // Setup the options for prerendering the SPA shell (i.e `src/routes/__root.tsx`)
-              if (options.spa?.enabled) {
-                options.prerender = {
-                  ...options.prerender,
-                  enabled: true,
-                }
-
-                const maskUrl = new URL(
-                  options.spa.maskPath,
-                  'http://localhost',
-                )
-
-                maskUrl.searchParams.set('__TSS_SHELL', 'true')
-
-                options.pages.push({
-                  path: maskUrl.toString().replace('http://localhost', ''),
-                  prerender: options.spa.prerender,
-                  sitemap: {
-                    exclude: true,
-                  },
-                })
-              }
-
-              // Start prerendering!!!
-              if (options.prerender.enabled) {
-                await prerender({
-                  options,
-                  nitro,
-                  builder,
-                })
-              }
-
-              // if (nitroConfig.prerender?.routes?.length && options.sitemap) {
-              //   console.log('Building Sitemap...')
-              //   // sitemap needs to be built after all directories are built
-              //   await buildSitemap({
-              //     host: options.sitemap.host,
-              //     routes: nitroConfig.prerender.routes,
-              //     outputDir: resolve(options.root, 'dist/public'),
-              //   })
-              // }
-
-              // console.log(
-              //   `\n\n✅ Client and server bundles successfully built.`,
-              // )
+              await buildNitroApp(builder, nitro, options)
             },
           },
         }
@@ -153,6 +102,93 @@ export function nitroPlugin(
   ]
 }
 
+/**
+ * Correctly co-ordinates the nitro app build process to make sure that the
+ * app is built, while also correctly handling the prerendering and sitemap
+ * generation and including their outputs in the final build.
+ */
+async function buildNitroApp(
+  builder: ViteBuilder,
+  nitro: Nitro,
+  options: TanStackStartOutputConfig,
+) {
+  // Cleans the public and server directories for a fresh build
+  // i.e the `.output/public` and `.output/server` directories
+  await prepare(nitro)
+
+  // Creates the `.output/public` directory and copies the public assets
+  await copyPublicAssets(nitro)
+
+  // If the user has not set a prerender option, we need to set it to true
+  // if the pages array is not empty and has sub options requiring for prerendering
+  if (options.prerender?.enabled !== false) {
+    options.prerender = {
+      ...options.prerender,
+      enabled: options.pages.some((d) =>
+        typeof d === 'string' ? false : !!d.prerender?.enabled,
+      ),
+    }
+  }
+
+  // Setup the options for prerendering the SPA shell (i.e `src/routes/__root.tsx`)
+  if (options.spa?.enabled) {
+    options.prerender = {
+      ...options.prerender,
+      enabled: true,
+    }
+
+    const maskUrl = new URL(options.spa.maskPath, 'http://localhost')
+
+    maskUrl.searchParams.set('__TSS_SHELL', 'true')
+
+    options.pages.push({
+      path: maskUrl.toString().replace('http://localhost', ''),
+      prerender: options.spa.prerender,
+      sitemap: {
+        exclude: true,
+      },
+    })
+  }
+
+  // Run the prerendering process
+  if (options.prerender.enabled) {
+    await prerender({
+      options,
+      nitro,
+      builder,
+    })
+  }
+
+  // Run the sitemap build process
+  if (options.pages.length) {
+    buildSitemap({
+      options,
+      publicDir: nitro.options.output.publicDir,
+    })
+  }
+
+  // Build the nitro app
+  await build(nitro)
+
+  // Cleanup the vite public directory
+  // As a part of the build process, a `.vite/` directory
+  // is copied over from `.tanstack-start/build/client-dist/`
+  // to the nitro `publicDir` (e.g. `.output/public/`).
+  // This directory (and its contents including the vite client manifest)
+  // should not be included in the final build, so we remove it.
+  const nitroPublicDir = nitro.options.output.publicDir
+  const viteDir = path.resolve(nitroPublicDir, '.vite')
+  if (await fsp.stat(viteDir).catch(() => false)) {
+    await fsp.rm(viteDir, { recursive: true, force: true })
+  }
+
+  // Close the nitro instance
+  await nitro.close()
+  nitro.logger.success(
+    'Client and Server bundles for TanStack Start have been successfully built.',
+  )
+}
+
 function virtualBundlePlugin(ssrBundle: Rollup.OutputBundle): Rollup.Plugin {
   type VirtualModule = { code: string; map: string | null }
   const _modules = new Map<string, VirtualModule>()

package/src/plugin.ts

@@ -77,7 +77,10 @@ export function TanStackStartVitePluginCore(
           )
             ? startConfig.clientEntryPath
             : vite.normalizePath(
-                path.resolve(startConfig.root, startConfig.clientEntryPath),
+                path.join(
+                  '/@fs',
+                  path.resolve(startConfig.root, startConfig.clientEntryPath),
+                ),
               )
 
           return entry
@@ -141,8 +144,8 @@ export function TanStackStartVitePluginCore(
               '@tanstack/start-router-manifest',
               '@tanstack/start-config',
               '@tanstack/server-functions-plugin',
-              'tanstack:start-manifest',
-              'tanstack:server-fn-manifest',
+              'tanstack-start-router-manifest:v',
+              'tanstack-start-server-fn-manifest:v',
               'nitropack',
               '@tanstack/**',
             ],
@@ -166,7 +169,9 @@ export function TanStackStartVitePluginCore(
     TanStackServerFnPluginEnv({
       // This is the ID that will be available to look up and import
       // our server function manifest and resolve its module
-      manifestVirtualImportId: 'tanstack:server-fn-manifest',
+      manifestVirtualImportId: 'tanstack-start-server-fn-manifest:v',
+      manifestOutputFilename:
+        '.tanstack-start/build/server/server-functions-manifest.json',
       client: {
         getRuntimeCode: () =>
           `import { createClientRpc } from '@tanstack/${opts.framework}-start/server-functions-client'`,

package/src/prerender.ts

@@ -5,8 +5,8 @@ import { getRollupConfig } from 'nitropack/rollup'
 import { build as buildNitro, createNitro } from 'nitropack'
 import { joinURL, withBase, withoutBase } from 'ufo'
 import { Queue } from './queue'
-import { buildNitroEnvironment } from './nitro/build-nitro'
 import { VITE_ENVIRONMENT_NAMES } from './constants'
+import { createLogger } from './utils'
 import type { ViteBuilder } from 'vite'
 import type { $Fetch, Nitro } from 'nitropack'
 import type { TanStackStartOutputConfig } from './plugin'
@@ -21,7 +21,8 @@ export async function prerender({
   nitro: Nitro
   builder: ViteBuilder
 }) {
-  console.info('Prendering pages...')
+  const logger = createLogger('prerender')
+  logger.info('Prendering pages...')
 
   // If prerender is enabled but no pages are provided, default to prerendering the root page
   if (options.prerender?.enabled && !options.pages.length) {
@@ -72,7 +73,7 @@ export async function prerender({
     },
   }
 
-  await buildNitroEnvironment(nodeNitro, () => buildNitro(nodeNitro))
+  await buildNitro(nodeNitro)
 
   // Import renderer entry
   const serverFilename =
@@ -93,14 +94,14 @@ export async function prerender({
     // Crawl all pages
     const pages = await prerenderPages()
 
-    console.info(`Prerendered ${pages.length} pages:`)
+    logger.info(`Prerendered ${pages.length} pages:`)
     pages.forEach((page) => {
-      console.info(`- ${page}`)
+      logger.info(`- ${page}`)
     })
 
     // TODO: Write the prerendered pages to the output directory
   } catch (error) {
-    console.error(error)
+    logger.error(error)
   } finally {
     // Ensure server is always closed
     // server.process.kill()
@@ -126,18 +127,10 @@ export async function prerender({
     const seen = new Set<string>()
     const retriesByPath = new Map<string, number>()
     const concurrency = options.prerender?.concurrency ?? os.cpus().length
-    console.info(`Concurrency: ${concurrency}`)
+    logger.info(`Concurrency: ${concurrency}`)
     const queue = new Queue({ concurrency })
 
-    options.pages.forEach((_page) => {
-      let page = _page as Page
-
-      if (typeof _page === 'string') {
-        page = { path: _page }
-      }
-
-      addCrawlPageTask(page)
-    })
+    options.pages.forEach((page) => addCrawlPageTask(page))
 
     await queue.start()
 
@@ -168,7 +161,7 @@ export async function prerender({
 
       // Add the task
       queue.add(async () => {
-        console.info(`Crawling: ${page.path}`)
+        logger.info(`Crawling: ${page.path}`)
         const retries = retriesByPath.get(page.path) || 0
         try {
           // Fetch the route
@@ -236,7 +229,7 @@ export async function prerender({
           }
         } catch (error) {
           if (retries < (prerenderOptions.retryCount ?? 0)) {
-            console.warn(`Encountered error, retrying: ${page.path} in 500ms`)
+            logger.warn(`Encountered error, retrying: ${page.path} in 500ms`)
             await new Promise((resolve) =>
               setTimeout(resolve, prerenderOptions.retryDelay),
             )

package/src/routesManifestPlugin.ts

@@ -2,6 +2,7 @@ import { readFileSync } from 'node:fs'
 import path from 'node:path'
 import { joinURL } from 'ufo'
 import { rootRouteId } from '@tanstack/router-core'
+import { resolveViteId } from './utils'
 import type {
   PluginOption,
   ResolvedConfig,
@@ -16,6 +17,9 @@ export function startManifestPlugin(
 ): PluginOption {
   let config: ResolvedConfig
 
+  const moduleId = 'tanstack-start-router-manifest:v'
+  const resolvedModuleId = resolveViteId(moduleId)
+
   return {
     name: 'tsr-routes-manifest',
     enforce: 'pre',
@@ -27,13 +31,13 @@ export function startManifestPlugin(
     //   config = envConfig.
     // },
     resolveId(id) {
-      if (id === 'tanstack:start-manifest') {
-        return id
+      if (id === moduleId) {
+        return resolvedModuleId
       }
       return
     },
     load(id) {
-      if (id === 'tanstack:start-manifest') {
+      if (id === resolvedModuleId) {
         if (this.environment.config.consumer !== 'server') {
           // this will ultimately fail the build if the plugin is used outside the server environment
           // TODO: do we need special handling for `serve`?

package/src/schema.ts

@@ -4,9 +4,12 @@ import { z } from 'zod'
 import { configSchema, getConfig } from '@tanstack/router-generator'
 import type { NitroConfig } from 'nitropack'
 
-const tsrConfig = configSchema.partial().extend({
-  srcDirectory: z.string().optional().default('src'),
-})
+const tsrConfig = configSchema
+  .omit({ autoCodeSplitting: true })
+  .partial()
+  .extend({
+    srcDirectory: z.string().optional().default('src'),
+  })
 
 export function createTanStackConfig<
   TFrameworkPlugin extends Record<string, unknown>,
@@ -111,13 +114,12 @@ export function createTanStackStartOptionsSchema(
         })
         .optional()
         .default({}),
-      pages: z
-        .array(z.union([z.string(), pageSchema]))
-        .optional()
-        .default([]),
-      sitemap: pagePrerenderOptionsSchema
-        .extend({
+      pages: z.array(pageSchema).optional().default([]),
+      sitemap: z
+        .object({
+          enabled: z.boolean().optional().default(true),
           host: z.string().optional(),
+          outputPath: z.string().optional().default('sitemap.xml'),
         })
         .optional(),
       prerender: z

package/src/start-server-routes-plugin/plugin.ts

@@ -30,6 +30,7 @@ const setLock = (bool: boolean) => {
 
 export function TanStackStartServerRoutesVite(config: Config): Plugin {
   let ROOT: string = process.cwd()
+  const moduleId = 'tanstack-start-server-routes-manifest:v'
 
   const getRoutesDirectoryPath = () => {
     return isAbsolute(config.routesDirectory)
@@ -80,7 +81,7 @@ export function TanStackStartServerRoutesVite(config: Config): Plugin {
     },
     sharedDuringBuild: true,
     resolveId(id) {
-      if (id === 'tanstack:server-routes') {
+      if (id === moduleId) {
         const generatedRouteTreePath = getGeneratedRouteTreePath(ROOT)
         return generatedRouteTreePath
       }

package/src/utils.ts

@@ -0,0 +1,14 @@
+export function resolveViteId(id: string) {
+  return `\0${id}`
+}
+
+export function createLogger(prefix: string) {
+  const label = `[${prefix}]`
+  return {
+    log: (...args: any) => console.log(label, ...args),
+    debug: (...args: any) => console.debug(label, ...args),
+    info: (...args: any) => console.info(label, ...args),
+    warn: (...args: any) => console.warn(label, ...args),
+    error: (...args: any) => console.error(label, ...args),
+  }
+}

package/dist/cjs/nitro/build-nitro.cjs

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const fs = require("node:fs");
-const path = require("node:path");
-const nitropack = require("nitropack");
-async function buildNitroEnvironment(nitro, build) {
-  await nitropack.prepare(nitro);
-  await nitropack.copyPublicAssets(nitro);
-  await build();
-  const publicDir = nitro.options.output.publicDir;
-  const viteDir = path.resolve(publicDir, ".vite");
-  if (await fs.promises.stat(viteDir).catch(() => false)) {
-    await fs.promises.rm(viteDir, { recursive: true, force: true });
-  }
-  await nitro.close();
-}
-exports.buildNitroEnvironment = buildNitroEnvironment;
-//# sourceMappingURL=build-nitro.cjs.map

package/dist/cjs/nitro/build-nitro.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-nitro.cjs","sources":["../../../src/nitro/build-nitro.ts"],"sourcesContent":["import { promises as fsp } from 'node:fs'\nimport path from 'node:path'\nimport { copyPublicAssets, prepare } from 'nitropack'\nimport type { Nitro } from 'nitropack'\n\nexport async function buildNitroEnvironment(\n  nitro: Nitro,\n  build: () => Promise<any>,\n) {\n  await prepare(nitro)\n  await copyPublicAssets(nitro)\n  await build()\n\n  const publicDir = nitro.options.output.publicDir\n\n  // As a part of the build process, the `.vite/` directory\n  // is copied over from `.tanstack-start/build/client-dist/`\n  // to the `publicDir` (e.g. `.output/public/`).\n  // This directory (containing the vite manifest) should not be\n  // included in the final build, so we remove it here.\n  const viteDir = path.resolve(publicDir, '.vite')\n  if (await fsp.stat(viteDir).catch(() => false)) {\n    await fsp.rm(viteDir, { recursive: true, force: true })\n  }\n\n  await nitro.close()\n}\n"],"names":["prepare","copyPublicAssets","fsp"],"mappings":";;;;;AAKsB,eAAA,sBACpB,OACA,OACA;AACA,QAAMA,UAAAA,QAAQ,KAAK;AACnB,QAAMC,UAAAA,iBAAiB,KAAK;AAC5B,QAAM,MAAM;AAEN,QAAA,YAAY,MAAM,QAAQ,OAAO;AAOvC,QAAM,UAAU,KAAK,QAAQ,WAAW,OAAO;AAC3C,MAAA,MAAMC,YAAI,KAAK,OAAO,EAAE,MAAM,MAAM,KAAK,GAAG;AACxC,UAAAA,GAAA,SAAI,GAAG,SAAS,EAAE,WAAW,MAAM,OAAO,MAAM;AAAA,EAAA;AAGxD,QAAM,MAAM,MAAM;AACpB;;"}

package/dist/cjs/nitro/build-nitro.d.cts

@@ -1,2 +0,0 @@
-import { Nitro } from 'nitropack';
-export declare function buildNitroEnvironment(nitro: Nitro, build: () => Promise<any>): Promise<void>;

package/dist/cjs/nitro/build-sitemap.d.cts

@@ -1,9 +0,0 @@
-export type PagesJson = {
-    page: string;
-    lastMod: string;
-};
-export declare function buildSitemap({ host, routes, outputDir, }: {
-    host: string;
-    routes: Array<string | undefined> | (() => Promise<Array<string | undefined>>);
-    outputDir: string;
-}): Promise<void>;

package/dist/esm/nitro/build-nitro.d.ts

@@ -1,2 +0,0 @@
-import { Nitro } from 'nitropack';
-export declare function buildNitroEnvironment(nitro: Nitro, build: () => Promise<any>): Promise<void>;

package/dist/esm/nitro/build-nitro.js

@@ -1,18 +0,0 @@
-import { promises } from "node:fs";
-import path from "node:path";
-import { prepare, copyPublicAssets } from "nitropack";
-async function buildNitroEnvironment(nitro, build) {
-  await prepare(nitro);
-  await copyPublicAssets(nitro);
-  await build();
-  const publicDir = nitro.options.output.publicDir;
-  const viteDir = path.resolve(publicDir, ".vite");
-  if (await promises.stat(viteDir).catch(() => false)) {
-    await promises.rm(viteDir, { recursive: true, force: true });
-  }
-  await nitro.close();
-}
-export {
-  buildNitroEnvironment
-};
-//# sourceMappingURL=build-nitro.js.map

package/dist/esm/nitro/build-nitro.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-nitro.js","sources":["../../../src/nitro/build-nitro.ts"],"sourcesContent":["import { promises as fsp } from 'node:fs'\nimport path from 'node:path'\nimport { copyPublicAssets, prepare } from 'nitropack'\nimport type { Nitro } from 'nitropack'\n\nexport async function buildNitroEnvironment(\n  nitro: Nitro,\n  build: () => Promise<any>,\n) {\n  await prepare(nitro)\n  await copyPublicAssets(nitro)\n  await build()\n\n  const publicDir = nitro.options.output.publicDir\n\n  // As a part of the build process, the `.vite/` directory\n  // is copied over from `.tanstack-start/build/client-dist/`\n  // to the `publicDir` (e.g. `.output/public/`).\n  // This directory (containing the vite manifest) should not be\n  // included in the final build, so we remove it here.\n  const viteDir = path.resolve(publicDir, '.vite')\n  if (await fsp.stat(viteDir).catch(() => false)) {\n    await fsp.rm(viteDir, { recursive: true, force: true })\n  }\n\n  await nitro.close()\n}\n"],"names":["fsp"],"mappings":";;;AAKsB,eAAA,sBACpB,OACA,OACA;AACA,QAAM,QAAQ,KAAK;AACnB,QAAM,iBAAiB,KAAK;AAC5B,QAAM,MAAM;AAEN,QAAA,YAAY,MAAM,QAAQ,OAAO;AAOvC,QAAM,UAAU,KAAK,QAAQ,WAAW,OAAO;AAC3C,MAAA,MAAMA,SAAI,KAAK,OAAO,EAAE,MAAM,MAAM,KAAK,GAAG;AACxC,UAAAA,SAAI,GAAG,SAAS,EAAE,WAAW,MAAM,OAAO,MAAM;AAAA,EAAA;AAGxD,QAAM,MAAM,MAAM;AACpB;"}

package/dist/esm/nitro/build-sitemap.d.ts

@@ -1,9 +0,0 @@
-export type PagesJson = {
-    page: string;
-    lastMod: string;
-};
-export declare function buildSitemap({ host, routes, outputDir, }: {
-    host: string;
-    routes: Array<string | undefined> | (() => Promise<Array<string | undefined>>);
-    outputDir: string;
-}): Promise<void>;

package/src/nitro/build-nitro.ts

@@ -1,27 +0,0 @@
-import { promises as fsp } from 'node:fs'
-import path from 'node:path'
-import { copyPublicAssets, prepare } from 'nitropack'
-import type { Nitro } from 'nitropack'
-
-export async function buildNitroEnvironment(
-  nitro: Nitro,
-  build: () => Promise<any>,
-) {
-  await prepare(nitro)
-  await copyPublicAssets(nitro)
-  await build()
-
-  const publicDir = nitro.options.output.publicDir
-
-  // As a part of the build process, the `.vite/` directory
-  // is copied over from `.tanstack-start/build/client-dist/`
-  // to the `publicDir` (e.g. `.output/public/`).
-  // This directory (containing the vite manifest) should not be
-  // included in the final build, so we remove it here.
-  const viteDir = path.resolve(publicDir, '.vite')
-  if (await fsp.stat(viteDir).catch(() => false)) {
-    await fsp.rm(viteDir, { recursive: true, force: true })
-  }
-
-  await nitro.close()
-}

package/src/nitro/build-sitemap.ts

@@ -1,79 +0,0 @@
-import { writeFileSync } from 'node:fs'
-import { resolve } from 'node:path'
-import { create } from 'xmlbuilder2'
-import type { XMLBuilder } from 'xmlbuilder2/lib/interfaces'
-
-export type PagesJson = {
-  page: string
-  lastMod: string
-}
-
-export async function buildSitemap({
-  host,
-  routes,
-  outputDir,
-}: {
-  host: string
-  routes: Array<string | undefined> | (() => Promise<Array<string | undefined>>)
-  outputDir: string
-}) {
-  const routeList: Array<string> = await optionHasRoutes(routes)
-
-  if (routeList.length) {
-    const slash = checkSlash(host)
-    const sitemapData: Array<PagesJson> = routeList.map((page: string) => ({
-      page: `${host}${slash}${page.replace(/^\/+/g, '')}`,
-      lastMod: new Date().toISOString().split('T')[0]!,
-    }))
-
-    const sitemap = createXml('urlset')
-
-    for (const item of sitemapData) {
-      const page = sitemap.ele('url')
-      page.ele('loc').txt(item.page)
-      page.ele('lastmod').txt(item.lastMod)
-    }
-
-    const mapPath = `${resolve(outputDir)}/sitemap.xml`
-    try {
-      console.log(`Writing sitemap at ${mapPath}`)
-      writeFileSync(mapPath, sitemap.end({ prettyPrint: true }))
-    } catch (e) {
-      console.error(`Unable to write file at ${mapPath}`, e)
-    }
-  }
-}
-
-function createXml(elementName: 'urlset' | 'sitemapindex'): XMLBuilder {
-  return create({ version: '1.0', encoding: 'UTF-8' })
-    .ele(elementName, {
-      xmlns: 'https://www.sitemaps.org/schemas/sitemap/0.9',
-    })
-    .com(`This file was automatically generated by Analog.`)
-}
-
-function checkSlash(host: string): string {
-  const finalChar = host.slice(-1)
-  return finalChar === '/' ? '' : '/'
-}
-
-async function optionHasRoutes(
-  routes:
-    | Array<string | undefined>
-    | (() => Promise<Array<string | undefined>>),
-): Promise<Array<string>> {
-  let routeList: Array<string | undefined>
-
-  if (typeof routes === 'function') {
-    // returns an array or undefined
-    routeList = await routes()
-  } else if (Array.isArray(routes)) {
-    // returns an array of strings
-    routeList = routes
-  } else {
-    // default it to an empty of array
-    routeList = []
-  }
-
-  return routeList.filter(Boolean) as Array<string>
-}