Skip to content
Source
Sign inSign up
TanStack/cli
Open History to see the last commit

registry.ts

106 lines3.0 KB

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'
7​
8const registrySchema = z.object({
9 starters: 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 'add-ons': z
22 .array(
23 z.object({
24 name: z.string(),
25 description: z.string(),
26 url: z.string(),
27 modes: z.array(z.string()),
28 framework: z.string(),
29 }),
30 )
31 .optional(),
32})
33​
34export type Registry = z.infer<typeof registrySchema>
35​
36function absolutizeUrl(originalUrl: string, relativeUrl: string) {
37 if (relativeUrl.startsWith('http') || relativeUrl.startsWith('https')) {
38 return relativeUrl
39 }
40 const baseUrl = originalUrl.replace(/registry.json$/, '')
41 return `${baseUrl}${relativeUrl.replace(/^\.\//, '')}`
43​
44export async function getRawRegistry(
45 registryUrl?: string,
46): Promise<Registry | undefined> {
47 const regUrl = registryUrl || process.env.CTA_REGISTRY
48 if (regUrl) {
49 const url = handleSpecialURL(regUrl)
50 const registry = (await fetch(url).then((res) => res.json())) as Registry
51 const parsedRegistry = registrySchema.parse(registry)
52 for (const addOn of parsedRegistry['add-ons'] || []) {
53 addOn.url = absolutizeUrl(url, addOn.url)
54 }
55 for (const starter of parsedRegistry.starters || []) {
56 starter.url = absolutizeUrl(url, starter.url)
57 if (starter.banner) {
58 starter.banner = absolutizeUrl(url, starter.banner)
59 }
60 }
61 return parsedRegistry
62 }
64​
65async function getAddOns(registry: Registry): Promise<Array<AddOn>> {
66 const addOns: Array<AddOn> = []
67 for (const addOnInfo of registry['add-ons'] || []) {
68 const addOn = await loadRemoteAddOn(addOnInfo.url)
69 addOns.push(addOn)
70 }
71 return addOns
73​
74export async function getRegistryAddOns(
75 registryUrl?: string,
76): Promise<Array<AddOn>> {
77 const registry = await getRawRegistry(registryUrl)
78 return registry ? await getAddOns(registry) : []
80​
81async function getStarters(registry: Registry): Promise<Array<Starter>> {
82 const starters: Array<Starter> = []
83 for (const starterInfo of registry.starters || []) {
84 const starter = await loadStarter(starterInfo.url)
85 starters.push(starter)
86 }
87 return starters
89​
90export async function getRegistryStarters(
91 registryUrl?: string,
92): Promise<Array<Starter>> {
93 const registry = await getRawRegistry(registryUrl)
94 return registry ? await getStarters(registry) : []
96​
97export async function getRegistry(registryUrl?: string): Promise<{
98 addOns: Array<AddOn>
99 starters: Array<Starter>
100}> {
101 const registry = await getRawRegistry(registryUrl)
102 return {
103 addOns: registry ? await getAddOns(registry) : [],
104 starters: registry ? await getStarters(registry) : [],
105 }