Open History to see the last commit
1import { z } from 'zod'
2import { loadRemoteAddOn } from './custom-add-ons/add-on.js'
3import { loadStarter } from './custom-add-ons/starter.js'
4import { handleSpecialURL } from './utils.js'
5
6import type { AddOn, Starter } from './types.js'
7
8const registrySchema = z.object({
9 templates: z
10 .array(
11 z.object({
12 name: z.string(),
13 description: z.string(),
14 url: z.string(),
15 banner: z.string().optional(),
16 mode: z.string(),
17 framework: z.string(),
18 }),
19 )
20 .optional(),
21 starters: z
22 .array(
23 z.object({
24 name: z.string(),
25 description: z.string(),
26 url: z.string(),
27 banner: z.string().optional(),
28 mode: z.string(),
29 framework: z.string(),
30 }),
31 )
32 .optional(),
33 'add-ons': z
34 .array(
35 z.object({
36 name: z.string(),
37 description: z.string(),
38 url: z.string(),
39 modes: z.array(z.string()),
40 framework: z.string(),
41 }),
42 )
43 .optional(),
44})
45
46export type Registry = z.infer<typeof registrySchema>
47
48function absolutizeUrl(originalUrl: string, relativeUrl: string) {
49 if (relativeUrl.startsWith('http') || relativeUrl.startsWith('https')) {
50 return relativeUrl
51 }
52 const baseUrl = originalUrl.replace(/registry.json$/, '')
53 return `${baseUrl}${relativeUrl.replace(/^\.\//, '')}`
54}
55
56export async function getRawRegistry(
57 registryUrl?: string,
58): Promise<Registry | undefined> {
59 const regUrl = registryUrl || process.env.CTA_REGISTRY
60 if (regUrl) {
61 const url = handleSpecialURL(regUrl)
62 const registry = (await fetch(url).then((res) => res.json())) as Registry
63 const parsedRegistry = registrySchema.parse(registry)
64
65 if (!parsedRegistry.starters && parsedRegistry.templates) {
66 parsedRegistry.starters = parsedRegistry.templates
67 }
68
69 if (!parsedRegistry.templates && parsedRegistry.starters) {
70 parsedRegistry.templates = parsedRegistry.starters
71 }
72
73 for (const addOn of parsedRegistry['add-ons'] || []) {
74 addOn.url = absolutizeUrl(url, addOn.url)
75 }
76 for (const template of parsedRegistry.templates || []) {
77 template.url = absolutizeUrl(url, template.url)
78 if (template.banner) {
79 template.banner = absolutizeUrl(url, template.banner)
80 }
81 }
82
83 parsedRegistry.starters = parsedRegistry.templates
84
85 return parsedRegistry
86 }
87}
88
89async function getAddOns(registry: Registry): Promise<Array<AddOn>> {
90 const addOns: Array<AddOn> = []
91 for (const addOnInfo of registry['add-ons'] || []) {
92 const addOn = await loadRemoteAddOn(addOnInfo.url)
93 addOns.push(addOn)
94 }
95 return addOns
96}
97
98export async function getRegistryAddOns(
99 registryUrl?: string,
100): Promise<Array<AddOn>> {
101 const registry = await getRawRegistry(registryUrl)
102 return registry ? await getAddOns(registry) : []
103}
104
105async function getStarters(registry: Registry): Promise<Array<Starter>> {
106 const starters: Array<Starter> = []
107 for (const starterInfo of registry.starters || []) {
108 const starter = await loadStarter(starterInfo.url)
109 starters.push(starter)
110 }
111 return starters
112}
113
114export async function getRegistryStarters(
115 registryUrl?: string,
116): Promise<Array<Starter>> {
117 const registry = await getRawRegistry(registryUrl)
118 return registry ? await getStarters(registry) : []
119}
120
121export async function getRegistry(registryUrl?: string): Promise<{
122 addOns: Array<AddOn>
123 starters: Array<Starter>
124}> {
125 const registry = await getRawRegistry(registryUrl)
126 return {
127 addOns: registry ? await getAddOns(registry) : [],
128 starters: registry ? await getStarters(registry) : [],
129 }
130}