@tanstack/cta-engine 0.15.0 → 0.15.2

package/dist/index.js

@@ -9,7 +9,7 @@ export { DEFAULT_PACKAGE_MANAGER, SUPPORTED_PACKAGE_MANAGERS, getPackageManager,
 export { registerFramework, getFrameworkById, getFrameworkByName, getFrameworks, } from './frameworks.js';
 export { writeConfigFileToEnvironment, readConfigFileFromEnvironment, readConfigFile, } from './config-file.js';
 export { cleanUpFiles, cleanUpFileArray, readFileHelper, getBinaryFile, recursivelyGatherFiles, relativePath, } from './file-helpers.js';
-export { formatCommand } from './utils.js';
+export { formatCommand, handleSpecialURL } from './utils.js';
 export { initStarter, compileStarter } from './custom-add-ons/starter.js';
 export { initAddOn, compileAddOn } from './custom-add-ons/add-on.js';
 export { createAppOptionsFromPersisted, createSerializedOptionsFromPersisted, } from './custom-add-ons/shared.js';

package/dist/registry.js

@@ -1,5 +1,28 @@
+import { z } from 'zod';
 import { loadRemoteAddOn } from './custom-add-ons/add-on.js';
 import { loadStarter } from './custom-add-ons/starter.js';
+import { handleSpecialURL } from './utils.js';
+const registrySchema = z.object({
+    starters: z
+        .array(z.object({
+        name: z.string(),
+        description: z.string(),
+        url: z.string(),
+        banner: z.string().optional(),
+        mode: z.enum(['code-router', 'file-router']),
+        framework: z.string(),
+    }))
+        .optional(),
+    'add-ons': z
+        .array(z.object({
+        name: z.string(),
+        description: z.string(),
+        url: z.string(),
+        modes: z.array(z.enum(['code-router', 'file-router'])),
+        framework: z.string(),
+    }))
+        .optional(),
+});
 function absolutizeUrl(originalUrl, relativeUrl) {
     if (relativeUrl.startsWith('http') || relativeUrl.startsWith('https')) {
         return relativeUrl;
@@ -10,22 +33,24 @@ function absolutizeUrl(originalUrl, relativeUrl) {
 export async function getRawRegistry(registryUrl) {
     const regUrl = registryUrl || process.env.CTA_REGISTRY;
     if (regUrl) {
-        const registry = (await fetch(regUrl).then((res) => res.json()));
-        for (const addOn of registry['add-ons']) {
-            addOn.url = absolutizeUrl(regUrl, addOn.url);
+        const url = handleSpecialURL(regUrl);
+        const registry = (await fetch(url).then((res) => res.json()));
+        const parsedRegistry = registrySchema.parse(registry);
+        for (const addOn of parsedRegistry['add-ons'] || []) {
+            addOn.url = absolutizeUrl(url, addOn.url);
         }
-        for (const starter of registry.starters) {
-            starter.url = absolutizeUrl(regUrl, starter.url);
+        for (const starter of parsedRegistry.starters || []) {
+            starter.url = absolutizeUrl(url, starter.url);
             if (starter.banner) {
-                starter.banner = absolutizeUrl(regUrl, starter.banner);
+                starter.banner = absolutizeUrl(url, starter.banner);
             }
         }
-        return registry;
+        return parsedRegistry;
     }
 }
 async function getAddOns(registry) {
     const addOns = [];
-    for (const addOnInfo of registry['add-ons']) {
+    for (const addOnInfo of registry['add-ons'] || []) {
         const addOn = await loadRemoteAddOn(addOnInfo.url);
         addOns.push(addOn);
     }
@@ -37,7 +62,7 @@ export async function getRegistryAddOns(registryUrl) {
 }
 async function getStarters(registry) {
     const starters = [];
-    for (const starterInfo of registry.starters) {
+    for (const starterInfo of registry.starters || []) {
         const starter = await loadStarter(starterInfo.url);
         starters.push(starter);
     }

package/dist/types/index.d.ts

@@ -9,7 +9,7 @@ export { DEFAULT_PACKAGE_MANAGER, SUPPORTED_PACKAGE_MANAGERS, getPackageManager,
 export { registerFramework, getFrameworkById, getFrameworkByName, getFrameworks, } from './frameworks.js';
 export { writeConfigFileToEnvironment, readConfigFileFromEnvironment, readConfigFile, } from './config-file.js';
 export { cleanUpFiles, cleanUpFileArray, readFileHelper, getBinaryFile, recursivelyGatherFiles, relativePath, } from './file-helpers.js';
-export { formatCommand } from './utils.js';
+export { formatCommand, handleSpecialURL } from './utils.js';
 export { initStarter, compileStarter } from './custom-add-ons/starter.js';
 export { initAddOn, compileAddOn } from './custom-add-ons/add-on.js';
 export { createAppOptionsFromPersisted, createSerializedOptionsFromPersisted, } from './custom-add-ons/shared.js';

package/dist/types/registry.d.ts

@@ -1,21 +1,81 @@
-import type { AddOn, Mode, Starter } from './types';
-export type Registry = {
-    starters: Array<{
+import { z } from 'zod';
+import type { AddOn, Starter } from './types';
+declare const registrySchema: z.ZodObject<{
+    starters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        url: z.ZodString;
+        banner: z.ZodOptional<z.ZodString>;
+        mode: z.ZodEnum<["code-router", "file-router"]>;
+        framework: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
         name: string;
         description: string;
         url: string;
-        banner?: string;
-        mode: Mode;
         framework: string;
-    }>;
-    'add-ons': Array<{
+        mode: "code-router" | "file-router";
+        banner?: string | undefined;
+    }, {
         name: string;
         description: string;
         url: string;
-        modes: Array<Mode>;
         framework: string;
-    }>;
-};
+        mode: "code-router" | "file-router";
+        banner?: string | undefined;
+    }>, "many">>;
+    'add-ons': z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        url: z.ZodString;
+        modes: z.ZodArray<z.ZodEnum<["code-router", "file-router"]>, "many">;
+        framework: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        url: string;
+        framework: string;
+        modes: ("code-router" | "file-router")[];
+    }, {
+        name: string;
+        description: string;
+        url: string;
+        framework: string;
+        modes: ("code-router" | "file-router")[];
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    starters?: {
+        name: string;
+        description: string;
+        url: string;
+        framework: string;
+        mode: "code-router" | "file-router";
+        banner?: string | undefined;
+    }[] | undefined;
+    'add-ons'?: {
+        name: string;
+        description: string;
+        url: string;
+        framework: string;
+        modes: ("code-router" | "file-router")[];
+    }[] | undefined;
+}, {
+    starters?: {
+        name: string;
+        description: string;
+        url: string;
+        framework: string;
+        mode: "code-router" | "file-router";
+        banner?: string | undefined;
+    }[] | undefined;
+    'add-ons'?: {
+        name: string;
+        description: string;
+        url: string;
+        framework: string;
+        modes: ("code-router" | "file-router")[];
+    }[] | undefined;
+}>;
+export type Registry = z.infer<typeof registrySchema>;
 export declare function getRawRegistry(registryUrl?: string): Promise<Registry | undefined>;
 export declare function getRegistryAddOns(registryUrl?: string): Promise<Array<AddOn>>;
 export declare function getRegistryStarters(registryUrl?: string): Promise<Array<Starter>>;
@@ -23,3 +83,4 @@ export declare function getRegistry(registryUrl?: string): Promise<{
     addOns: Array<AddOn>;
     starters: Array<Starter>;
 }>;
+export {};

package/dist/types/utils.d.ts

@@ -4,3 +4,4 @@ export declare function formatCommand({ command, args, }: {
     command: string;
     args: Array<string>;
 }): string;
+export declare function handleSpecialURL(url: string): string;

package/dist/utils.js

@@ -15,3 +15,17 @@ export function jsSafeName(name) {
 export function formatCommand({ command, args, }) {
     return `${command} ${args.join(' ')}`.trim();
 }
+// Turn GitHub URLs into raw URLs
+export function handleSpecialURL(url) {
+    if (url.startsWith('https://github.com/') && url.includes('blob')) {
+        return url
+            .replace('https://github.com/', 'https://raw.githubusercontent.com/')
+            .replace('/blob/', '/refs/heads/');
+    }
+    if (url.startsWith('https://github.com/') && url.includes('tree')) {
+        return url
+            .replace('https://github.com/', 'https://raw.githubusercontent.com/')
+            .replace('/tree/', '/refs/heads/');
+    }
+    return url;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/cta-engine",
-  "version": "0.15.0",
+  "version": "0.15.2",
   "description": "Tanstack Application Builder Engine",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -41,7 +41,7 @@ export {
   relativePath,
 } from './file-helpers.js'
 
-export { formatCommand } from './utils.js'
+export { formatCommand, handleSpecialURL } from './utils.js'
 
 export { initStarter, compileStarter } from './custom-add-ons/starter.js'
 export { initAddOn, compileAddOn } from './custom-add-ons/add-on.js'

package/src/registry.ts

@@ -1,25 +1,37 @@
+import { z } from 'zod'
 import { loadRemoteAddOn } from './custom-add-ons/add-on.js'
 import { loadStarter } from './custom-add-ons/starter.js'
+import { handleSpecialURL } from './utils.js'
 
-import type { AddOn, Mode, Starter } from './types'
+import type { AddOn, Starter } from './types'
 
-export type Registry = {
-  starters: Array<{
-    name: string
-    description: string
-    url: string
-    banner?: string
-    mode: Mode
-    framework: string
-  }>
-  'add-ons': Array<{
-    name: string
-    description: string
-    url: string
-    modes: Array<Mode>
-    framework: string
-  }>
-}
+const registrySchema = z.object({
+  starters: z
+    .array(
+      z.object({
+        name: z.string(),
+        description: z.string(),
+        url: z.string(),
+        banner: z.string().optional(),
+        mode: z.enum(['code-router', 'file-router']),
+        framework: z.string(),
+      }),
+    )
+    .optional(),
+  'add-ons': z
+    .array(
+      z.object({
+        name: z.string(),
+        description: z.string(),
+        url: z.string(),
+        modes: z.array(z.enum(['code-router', 'file-router'])),
+        framework: z.string(),
+      }),
+    )
+    .optional(),
+})
+
+export type Registry = z.infer<typeof registrySchema>
 
 function absolutizeUrl(originalUrl: string, relativeUrl: string) {
   if (relativeUrl.startsWith('http') || relativeUrl.startsWith('https')) {
@@ -34,23 +46,25 @@ export async function getRawRegistry(
 ): Promise<Registry | undefined> {
   const regUrl = registryUrl || process.env.CTA_REGISTRY
   if (regUrl) {
-    const registry = (await fetch(regUrl).then((res) => res.json())) as Registry
-    for (const addOn of registry['add-ons']) {
-      addOn.url = absolutizeUrl(regUrl, addOn.url)
+    const url = handleSpecialURL(regUrl)
+    const registry = (await fetch(url).then((res) => res.json())) as Registry
+    const parsedRegistry = registrySchema.parse(registry)
+    for (const addOn of parsedRegistry['add-ons'] || []) {
+      addOn.url = absolutizeUrl(url, addOn.url)
     }
-    for (const starter of registry.starters) {
-      starter.url = absolutizeUrl(regUrl, starter.url)
+    for (const starter of parsedRegistry.starters || []) {
+      starter.url = absolutizeUrl(url, starter.url)
       if (starter.banner) {
-        starter.banner = absolutizeUrl(regUrl, starter.banner)
+        starter.banner = absolutizeUrl(url, starter.banner)
       }
     }
-    return registry
+    return parsedRegistry
   }
 }
 
 async function getAddOns(registry: Registry): Promise<Array<AddOn>> {
   const addOns: Array<AddOn> = []
-  for (const addOnInfo of registry['add-ons']) {
+  for (const addOnInfo of registry['add-ons'] || []) {
     const addOn = await loadRemoteAddOn(addOnInfo.url)
     addOns.push(addOn)
   }
@@ -66,7 +80,7 @@ export async function getRegistryAddOns(
 
 async function getStarters(registry: Registry): Promise<Array<Starter>> {
   const starters: Array<Starter> = []
-  for (const starterInfo of registry.starters) {
+  for (const starterInfo of registry.starters || []) {
     const starter = await loadStarter(starterInfo.url)
     starters.push(starter)
   }

package/src/utils.ts

@@ -25,3 +25,18 @@ export function formatCommand({
 }) {
   return `${command} ${args.join(' ')}`.trim()
 }
+
+// Turn GitHub URLs into raw URLs
+export function handleSpecialURL(url: string) {
+  if (url.startsWith('https://github.com/') && url.includes('blob')) {
+    return url
+      .replace('https://github.com/', 'https://raw.githubusercontent.com/')
+      .replace('/blob/', '/refs/heads/')
+  }
+  if (url.startsWith('https://github.com/') && url.includes('tree')) {
+    return url
+      .replace('https://github.com/', 'https://raw.githubusercontent.com/')
+      .replace('/tree/', '/refs/heads/')
+  }
+  return url
+}

package/tests/utils.test.ts

@@ -1,6 +1,11 @@
 import { describe, expect, it } from 'vitest'
 
-import { formatCommand, jsSafeName, sortObject } from '../src/utils.js'
+import {
+  formatCommand,
+  handleSpecialURL,
+  jsSafeName,
+  sortObject,
+} from '../src/utils.js'
 
 describe('formatCommand', () => {
   it('should format a command', () => {
@@ -21,3 +26,23 @@ describe('sortObject', () => {
     expect(sortObject({ b: 'b', a: 'a' })).toEqual({ a: 'a', b: 'b' })
   })
 })
+
+describe('handleSpecialURL', () => {
+  it('should handle special URLs', () => {
+    expect(
+      handleSpecialURL(
+        'https://github.com/TanStack/create-tsrouter-app/blob/main/examples/react-cra/registry.json',
+      ),
+    ).toEqual(
+      'https://raw.githubusercontent.com/TanStack/create-tsrouter-app/refs/heads/main/examples/react-cra/registry.json',
+    )
+
+    expect(
+      handleSpecialURL(
+        'https://github.com/TanStack/create-tsrouter-app/tree/alpha/packages/cta-cli/tsconfig.json',
+      ),
+    ).toEqual(
+      'https://raw.githubusercontent.com/TanStack/create-tsrouter-app/refs/heads/alpha/packages/cta-cli/tsconfig.json',
+    )
+  })
+})