@tanstack/cta-engine 0.15.1 → 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,6 +1,7 @@
 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({
@@ -32,15 +33,16 @@ 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()));
+        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(regUrl, addOn.url);
+            addOn.url = absolutizeUrl(url, addOn.url);
         }
         for (const starter of parsedRegistry.starters || []) {
-            starter.url = absolutizeUrl(regUrl, starter.url);
+            starter.url = absolutizeUrl(url, starter.url);
             if (starter.banner) {
-                starter.banner = absolutizeUrl(regUrl, starter.banner);
+                starter.banner = absolutizeUrl(url, starter.banner);
             }
         }
         return parsedRegistry;

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/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.1",
+  "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,6 +1,7 @@
 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, Starter } from './types'
 
@@ -45,15 +46,16 @@ 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
+    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(regUrl, addOn.url)
+      addOn.url = absolutizeUrl(url, addOn.url)
     }
     for (const starter of parsedRegistry.starters || []) {
-      starter.url = absolutizeUrl(regUrl, starter.url)
+      starter.url = absolutizeUrl(url, starter.url)
       if (starter.banner) {
-        starter.banner = absolutizeUrl(regUrl, starter.banner)
+        starter.banner = absolutizeUrl(url, starter.banner)
       }
     }
     return parsedRegistry

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',
+    )
+  })
+})