Open History to see the last commit
1import path from 'node:path'
2import { z } from 'zod'
3import { configSchema, getConfig } from '@tanstack/router-plugin'
4import type { TanStackStartVitePluginCoreOptions } from './plugin'
5β
6const tsrConfig = configSchema
7 .omit({ autoCodeSplitting: true, target: true, verboseFileRoutes: true })
8 .partial()
9β
10export function parseStartConfig(
11 opts: z.input<typeof tanstackStartOptionsSchema>,
12 corePluginOpts: TanStackStartVitePluginCoreOptions,
13 root: string,
14) {
15 const options = tanstackStartOptionsSchema.parse(opts)
16β
17 const srcDirectory = options.srcDirectory
18β
19 const routesDirectory = path.resolve(
20 root,
21 srcDirectory,
22 options.router.routesDirectory ?? 'routes',
23 )
24β
25 const generatedRouteTree = path.resolve(
26 root,
27 srcDirectory,
28 options.router.generatedRouteTree ?? 'routeTree.gen.ts',
29 )
30β
31 return {
32 ...options,
33 router: {
34 ...options.router,
35 ...getConfig(
36 {
37 ...options.router,
38 routesDirectory,
39 generatedRouteTree,
40 },
41 root,
42 ),
43 target: corePluginOpts.framework,
44 },
45 }
46}
47β
48const pageSitemapOptionsSchema = z.object({
49 exclude: z.boolean().optional(),
50 priority: z.number().min(0).max(1).optional(),
51 changefreq: z
52 .enum(['always', 'hourly', 'daily', 'weekly', 'monthly', 'yearly', 'never'])
53 .optional(),
54 lastmod: z.union([z.string(), z.date()]).optional(),
55 alternateRefs: z
56 .array(
57 z.object({
58 href: z.string(),
59 hreflang: z.string(),
60 }),
61 )
62 .optional(),
63 images: z
64 .array(
65 z.object({
66 loc: z.string(),
67 caption: z.string().optional(),
68 title: z.string().optional(),
69 }),
70 )
71 .optional(),
72 news: z
73 .object({
74 publication: z.object({
75 name: z.string(),
76 language: z.string(),
77 }),
78 publicationDate: z.union([z.string(), z.date()]),
79 title: z.string(),
80 })
81 .optional(),
82})
83β
84const pageBaseSchema = z.object({
85 path: z.string(),
86 sitemap: pageSitemapOptionsSchema.optional(),
87 fromCrawl: z.boolean().optional(),
88})
89β
90const pagePrerenderOptionsSchema = z.object({
91 enabled: z.boolean().optional(),
92 outputPath: z.string().optional(),
93 autoSubfolderIndex: z.boolean().optional(),
94 crawlLinks: z.boolean().optional(),
95 retryCount: z.number().optional(),
96 retryDelay: z.number().optional(),
97 onSuccess: z
98 .function()
99 .args(
100 z.object({
101 page: pageBaseSchema,
102 html: z.string(),
103 }),
104 )
105 .returns(z.any())
106 .optional(),
107 headers: z.record(z.string(), z.string()).optional(),
108})
109β
110const spaSchema = z.object({
111 enabled: z.boolean().optional().default(true),
112 maskPath: z.string().optional().default('/'),
113 prerender: pagePrerenderOptionsSchema
114 .optional()
115 .default({})
116 .transform((opts) => ({
117 outputPath: opts.outputPath ?? '/_shell',
118 crawlLinks: false,
119 retryCount: 0,
120 ...opts,
121 enabled: true,
122 })),
123})
124β
125const pageSchema = pageBaseSchema.extend({
126 prerender: pagePrerenderOptionsSchema.optional(),
127})
128β
129const tanstackStartOptionsSchema = z
130 .object({
131 srcDirectory: z.string().optional().default('src'),
132 start: z
133 .object({
134 entry: z.string().optional(),
135 })
136 .optional()
137 .default({}),
138 router: z
139 .object({
140 entry: z.string().optional(),
141 basepath: z.string().optional(),
142 })
143 .and(tsrConfig.optional().default({}))
144 .optional()
145 .default({}),
146 client: z
147 .object({
148 entry: z.string().optional(),
149 base: z.string().optional().default('/_build'),
150 })
151 .optional()
152 .default({}),
153 server: z
154 .object({
155 entry: z.string().optional(),
156 })
157 .optional()
158 .default({}),
159 serverFns: z
160 .object({
161 base: z.string().optional().default('/_serverFn'),
162 generateFunctionId: z
163 .function()
164 .args(
165 z.object({
166 filename: z.string(),
167 functionName: z.string(),
168 }),
169 )
170 .returns(z.string().optional())
171 .optional(),
172 })
173 .optional()
174 .default({}),
175 pages: z.array(pageSchema).optional().default([]),
176 sitemap: z
177 .object({
178 enabled: z.boolean().optional().default(true),
179 host: z.string().optional(),
180 outputPath: z.string().optional().default('sitemap.xml'),
181 })
182 .optional(),
183 prerender: z
184 .object({
185 enabled: z.boolean().optional(),
186 concurrency: z.number().optional(),
187 filter: z.function().args(pageSchema).returns(z.any()).optional(),
188 failOnError: z.boolean().optional(),
189 })
190 .and(pagePrerenderOptionsSchema.optional())
191 .optional(),
192 spa: spaSchema.optional(),
193 vite: z
194 .object({ installDevServerMiddleware: z.boolean().optional() })
195 .optional(),
196 })
197 .optional()
198 .default({})
199β
200export type Page = z.infer<typeof pageSchema>
201β
202export type TanStackStartInputConfig = z.input<
203 typeof tanstackStartOptionsSchema
204>
205export type TanStackStartOutputConfig = ReturnType<typeof parseStartConfig>