Open History to see the last commit
1import z from 'zod'
2
3import type { PackageManager } from './package-manager.js'
4
5export type StatusStepType =
6 | 'file'
7 | 'command'
8 | 'info'
9 | 'package-manager'
10 | 'other'
11
12export const AddOnSelectOptionSchema = z.object({
13 type: z.literal('select'),
14 label: z.string(),
15 description: z.string().optional(),
16 default: z.string(),
17 options: z.array(
18 z.object({
19 value: z.string(),
20 label: z.string(),
21 }),
22 ),
23})
24
25export const AddOnOptionSchema = z.discriminatedUnion('type', [
26 AddOnSelectOptionSchema,
27])
28
29export const AddOnOptionsSchema = z.record(z.string(), AddOnOptionSchema)
30
31export const AddOnBaseSchema = z.object({
32 id: z.string(),
33 name: z.string(),
34 description: z.string(),
35 author: z.string().optional(),
36 version: z.string().optional(),
37 link: z.string().optional(),
38 license: z.string().optional(),
39 warning: z.string().optional(),
40 tailwind: z.boolean().optional(),
41 type: z.enum(['add-on', 'example', 'starter', 'toolchain', 'deployment']),
42 supportedPackageManagers: z
43 .array(z.enum(['npm', 'yarn', 'pnpm', 'bun', 'deno']))
44 .optional(),
45 category: z
46 .enum([
47 'tanstack',
48 'database',
49 'orm',
50 'auth',
51 'deploy',
52 'styling',
53 'monitoring',
54 'cms',
55 'api',
56 'analytics',
57 'i18n',
58 'tooling',
59 'other',
60 ])
61 .optional(),
62 exclusive: z
63 .array(z.enum(['orm', 'auth', 'deploy', 'database', 'linter']))
64 .optional(),
65 color: z.string().optional(),
66 priority: z.number().optional(),
67 partner: z
68 .object({
69 id: z.string(),
70 tier: z.enum(['gold', 'silver', 'bronze']),
71 placementWeight: z.number().positive().optional(),
72 })
73 .optional(),
74 command: z
75 .object({
76 command: z.string(),
77 args: z.array(z.string()).optional(),
78 allowBuilds: z.array(z.string()).optional(),
79 })
80 .optional(),
81 routes: z
82 .array(
83 z.object({
84 url: z.string().optional(),
85 name: z.string().optional(),
86 path: z.string().optional(),
87 jsName: z.string().optional(),
88 icon: z.string().optional(),
89 }),
90 )
91 .optional(),
92 packageAdditions: z
93 .object({
94 dependencies: z.record(z.string(), z.string()).optional(),
95 devDependencies: z.record(z.string(), z.string()).optional(),
96 engines: z.record(z.string(), z.string()).optional(),
97 pnpm: z
98 .object({
99 onlyBuiltDependencies: z.array(z.string()).optional(),
100 })
101 .optional(),
102 scripts: z.record(z.string(), z.string()).optional(),
103 })
104 .optional(),
105 variables: z.array(z.unknown()).optional(),
106 shadcnComponents: z.array(z.string()).optional(),
107 dependsOn: z.array(z.string()).optional(),
108 smallLogo: z.string().optional(),
109 logo: z.string().optional(),
110 addOnSpecialSteps: z.array(z.string()).optional(),
111 createSpecialSteps: z.array(z.string()).optional(),
112 postInitSpecialSteps: z.array(z.string()).optional(),
113 options: AddOnOptionsSchema.optional(),
114 envVars: z
115 .array(
116 z.object({
117 name: z.string(),
118 description: z.string().optional(),
119 required: z.boolean().optional(),
120 default: z.string().optional(),
121 secret: z.boolean().optional(),
122 file: z.enum(['.env', '.env.local']).optional(),
123 }),
124 )
125 .optional(),
126 default: z.boolean().optional(),
127})
128
129export const StarterSchema = AddOnBaseSchema.extend({
130 framework: z.string(),
131 mode: z.string(),
132 typescript: z.boolean(),
133 banner: z.string().optional(),
134})
135
136export const StarterCompiledSchema = StarterSchema.extend({
137 files: z.record(z.string(), z.string()),
138 deletedFiles: z.array(z.string()),
139})
140
141export const IntegrationSchema = z.object({
142 type: z.string().optional(),
143 path: z.string().optional(),
144 jsName: z.string().optional(),
145 import: z.string().optional(),
146 code: z.string().optional(),
147})
148
149export const AddOnInfoSchema = AddOnBaseSchema.extend({
150 modes: z.array(z.string()),
151 integrations: z.array(IntegrationSchema).optional(),
152 phase: z.enum(['setup', 'add-on', 'example']),
153 readme: z.string().optional(),
154 readmeIsEjs: z.boolean().optional(),
155})
156
157export const AddOnCompiledSchema = AddOnInfoSchema.extend({
158 files: z.record(z.string(), z.string()),
159 deletedFiles: z.array(z.string()),
160 packageTemplate: z.string().optional(),
161})
162
163export type AddOnSelectOption = z.infer<typeof AddOnSelectOptionSchema>
164
165export type AddOnOption = z.infer<typeof AddOnOptionSchema>
166
167export type AddOnOptions = z.infer<typeof AddOnOptionsSchema>
168
169export type Integration = z.infer<typeof IntegrationSchema>
170
171export type AddOnBase = z.infer<typeof AddOnBaseSchema>
172
173export type StarterInfo = z.infer<typeof StarterSchema>
174
175export type StarterCompiled = z.infer<typeof StarterCompiledSchema>
176
177export type AddOnInfo = z.infer<typeof AddOnInfoSchema>
178
179export type AddOnCompiled = z.infer<typeof AddOnCompiledSchema>
180
181export interface AddOnSelection {
182 id: string
183 enabled: boolean
184 options: Record<string, any>
185}
186
187export type FileBundleHandler = {
188 getFiles: () => Promise<Array<string>>
189 getFileContents: (path: string) => Promise<string>
190 getDeletedFiles: () => Promise<Array<string>>
191}
192
193export type AddOn = AddOnCompiled & FileBundleHandler
194
195export type Starter = StarterCompiled & FileBundleHandler
196
197export type BundlerDefinition = {
198 id: string
199 name: string
200 description: string
201}
202
203export type FrameworkDefinition = {
204 id: string
205 name: string
206 description: string
207 version: string
208
209 base: Record<string, string>
210 addOns: Array<AddOn>
211 basePackageJSON: Record<string, any>
212 optionalPackages: Record<string, any>
213
214 bundlers?: Array<BundlerDefinition>
215 defaultBundler?: string
216
217 supportedModes: Record<
218 string,
219 {
220 displayName: string
221 description: string
222 forceTypescript: boolean
223 }
224 >
225}
226
227export type Framework = Omit<FrameworkDefinition, 'base' | 'addOns'> &
228 FileBundleHandler & {
229 getAddOns: () => Array<AddOn>
230 }
231
232export interface Options {
233 projectName: string
234 targetDir: string
235
236 framework: Framework
237 mode: string
238 bundler?: string
239
240 typescript: boolean
241 tailwind: boolean
242
243 packageManager: PackageManager
244 git: boolean
245 install?: boolean
246 intent: boolean
247
248 chosenAddOns: Array<AddOn>
249 addOnOptions: Record<string, Record<string, any>>
250 starter?: Starter | undefined
251 projectPreset?: 'default' | 'blank'
252 routerOnly?: boolean
253 includeExamples?: boolean
254 envVarValues?: Record<string, string>
255}
256
257export type SerializedOptions = Omit<
258 Options,
259 'chosenAddOns' | 'starter' | 'framework'
260> & {
261 chosenAddOns: Array<string>
262 starter?: string | undefined
263 framework: string
264}
265
266type ProjectEnvironment = {
267 startRun: () => void
268 finishRun: () => void
269 getErrors: () => Array<string>
270}
271
272type FileEnvironment = {
273 getPackageManagerVersion?: (packageManager: PackageManager, cwd: string) => Promise<string | undefined>
274 appendFile: (path: string, contents: string) => Promise<void>
275 copyFile: (from: string, to: string) => Promise<void>
276 writeFile: (path: string, contents: string) => Promise<void>
277 writeFileBase64: (path: string, base64Contents: string) => Promise<void>
278 execute: (
279 command: string,
280 args: Array<string>,
281 cwd: string,
282 options?: { inherit?: boolean },
283 ) => Promise<{ stdout: string; failed?: boolean }>
284 deleteFile: (path: string) => Promise<void>
285
286 exists: (path: string) => boolean
287 isDirectory: (path: string) => boolean
288 readFile: (path: string) => Promise<string>
289 readdir: (path: string) => Promise<Array<string>>
290 rimraf: (path: string) => Promise<void>
291}
292
293export type StatusEvent = {
294 id: string
295 type: StatusStepType
296 message: string
297}
298export type StopEvent = {
299 id: string
300}
301
302type UIEnvironment = {
303 appName: string
304
305 startStep: (info: {
306 id: string
307 type: StatusStepType
308 message: string
309 }) => void
310 finishStep: (id: string, finalMessage: string) => void
311
312 intro: (message: string) => void
313 outro: (message: string) => void
314
315 info: (title?: string, message?: string) => void
316 error: (title?: string, message?: string) => void
317 warn: (title?: string, message?: string) => void
318
319 spinner: () => {
320 start: (message: string) => void
321 stop: (message: string) => void
322 }
323 confirm: (message: string) => Promise<boolean>
324}
325
326export type Environment = ProjectEnvironment & FileEnvironment & UIEnvironment
327
328// Attribution tracking types for file provenance
329export interface LineAttribution {
330 line: number
331 sourceId: string
332 sourceName: string
333 type: 'original' | 'injected'
334}
335
336export interface FileProvenance {
337 source: 'framework' | 'add-on' | 'starter'
338 sourceId: string
339 sourceName: string
340}
341
342export interface AttributedFile {
343 content: string
344 provenance: FileProvenance
345 lineAttributions: Array<LineAttribution>
346}
347
348export interface DependencyAttribution {
349 name: string
350 version: string
351 type: 'dependency' | 'devDependency'
352 sourceId: string
353 sourceName: string
354}
355
356// Integration with source add-on tracking (used in templates and attribution)
357export type IntegrationWithSource = Integration & {
358 _sourceId: string
359 _sourceName: string
360}