@tanstack/cta-engine 0.10.0-alpha.15 → 0.10.0-alpha.17

package/dist/cli.js

@@ -7,30 +7,29 @@ import { SUPPORTED_TOOLCHAINS } from './toolchain.js';
 import runServer from './mcp.js';
 import { listAddOns } from './add-ons.js';
 import { DEFAULT_FRAMEWORK, SUPPORTED_FRAMEWORKS } from './constants.js';
-import { initAddOn } from './custom-add-on.js';
+// import { initAddOn } from './custom-add-on.js'
 import { createDefaultEnvironment } from './environment.js';
-import { add } from './add.js';
 export function cli({ name, appName, forcedMode, forcedAddOns, }) {
     const program = new Command();
     program.name(name).description(`CLI to create a new ${appName} application`);
-    program
-        .command('add')
-        .argument('add-on', 'Name of the add-on (or add-ons separated by commas)')
-        .action(async (addOn) => {
-        await add(addOn.split(',').map((addon) => addon.trim()));
-    });
-    program
-        .command('update-add-on')
-        .description('Create or update an add-on from the current project')
-        .action(async () => {
-        await initAddOn('add-on');
-    });
-    program
-        .command('update-starter')
-        .description('Create or update a project starter from the current project')
-        .action(async () => {
-        await initAddOn('starter');
-    });
+    // program
+    //   .command('add')
+    //   .argument('add-on', 'Name of the add-on (or add-ons separated by commas)')
+    //   .action(async (addOn: string) => {
+    //     await add(addOn.split(',').map((addon) => addon.trim()))
+    //   })
+    // program
+    //   .command('update-add-on')
+    //   .description('Create or update an add-on from the current project')
+    //   .action(async () => {
+    //     await initAddOn('add-on')
+    //   })
+    // program
+    //   .command('update-overlay')
+    //   .description('Create or update a project overlay from the current project')
+    //   .action(async () => {
+    //     await initAddOn('overlay')
+    //   })
     program.argument('[project-name]', 'name of the project');
     if (!forcedMode) {
         program.option('--template <type>', 'project template (typescript, javascript, file-router)', (value) => {
@@ -49,7 +48,7 @@ export function cli({ name, appName, forcedMode, forcedAddOns, }) {
         }
         return value;
     }, DEFAULT_FRAMEWORK)
-        .option('--starter [url]', 'initialize this project from a starter URL', false)
+        // .option('--overlay [url]', 'add an overlay from a URL', false)
         .option(`--package-manager <${SUPPORTED_PACKAGE_MANAGERS.join('|')}>`, `Explicitly tell the CLI to use this package manager`, (value) => {
         if (!SUPPORTED_PACKAGE_MANAGERS.includes(value)) {
             throw new InvalidArgumentError(`Invalid package manager: ${value}. The following are allowed: ${SUPPORTED_PACKAGE_MANAGERS.join(', ')}`);
@@ -78,13 +77,13 @@ export function cli({ name, appName, forcedMode, forcedAddOns, }) {
     program.action(async (projectName, options) => {
         if (options.listAddOns) {
             await listAddOns(options, {
-                forcedMode,
+                forcedMode: forcedMode,
                 forcedAddOns,
             });
         }
         else if (options.mcp || options.mcpSse) {
             await runServer(!!options.mcpSse, {
-                forcedMode,
+                forcedMode: forcedMode,
                 forcedAddOns,
                 appName,
             });
@@ -98,14 +97,14 @@ export function cli({ name, appName, forcedMode, forcedAddOns, }) {
                 if (forcedMode) {
                     cliOptions.template = forcedMode;
                 }
-                let finalOptions = await normalizeOptions(cliOptions, forcedAddOns);
+                let finalOptions = await normalizeOptions(cliOptions, forcedMode, forcedAddOns);
                 if (finalOptions) {
                     intro(`Creating a new ${appName} app in ${projectName}...`);
                 }
                 else {
                     intro(`Let's configure your ${appName} application`);
                     finalOptions = await promptForOptions(cliOptions, {
-                        forcedMode,
+                        forcedMode: forcedMode,
                         forcedAddOns,
                     });
                 }

package/dist/create-app.js

@@ -332,9 +332,9 @@ export async function createApp(options, { silent = false, environment, cwd, app
                 }
             }
         }
-        if (options.starter) {
-            if (options.starter.shadcnComponents) {
-                for (const component of options.starter.shadcnComponents) {
+        if (options.overlay) {
+            if (options.overlay.shadcnComponents) {
+                for (const component of options.overlay.shadcnComponents) {
                     shadcnComponents.add(component);
                 }
             }
@@ -433,11 +433,11 @@ export async function createApp(options, { silent = false, environment, cwd, app
     }
     // Create the README.md
     await templateFile(templateDirBase, 'README.md.ejs');
-    // Adding starter
-    if (options.starter) {
-        s?.start(`Setting up starter ${options.starter.name}...`);
-        await runAddOn(options.starter);
-        s?.stop(`Starter ${options.starter.name} setup complete`);
+    // Adding overlay
+    if (options.overlay) {
+        s?.start(`Setting up overlay ${options.overlay.name}...`);
+        await runAddOn(options.overlay);
+        s?.stop(`Overlay ${options.overlay.name} setup complete`);
     }
     // Install dependencies
     s?.start(`Installing dependencies via ${options.packageManager}...`);
@@ -492,6 +492,6 @@ Use the following commands to start your app:
 % cd ${options.projectName}
 % ${startCommand}
 
-Please check the README.md for more information on testing, styling, adding routes, react-query, etc.${errorStatement}`);
+Please read the README.md for more information on testing, styling, adding routes, react-query, etc.${errorStatement}`);
     }
 }

package/dist/custom-add-on.js

@@ -9,11 +9,11 @@ import { finalizeAddOns } from './add-ons.js';
 import { readFileHelper } from './file-helper.js';
 const INFO_FILE = {
     'add-on': '.add-on/info.json',
-    starter: 'starter-info.json',
+    overlay: 'overlay-info.json',
 };
 const COMPILED_FILE = {
     'add-on': 'add-on.json',
-    starter: 'starter.json',
+    overlay: 'overlay.json',
 };
 const ADD_ON_DIR = '.add-on';
 const ASSETS_DIR = 'assets';
@@ -76,7 +76,7 @@ export default (parentRoute: RootRoute) => createRoute({
         .trim();
     return { url: path, code, name };
 }
-export async function createAppOptionsFromPersisted(json) {
+async function createOptions(json) {
     return {
         ...json,
         chosenAddOns: await finalizeAddOns(json.framework, json.mode, [...json.existingAddOns]),
@@ -154,13 +154,12 @@ To create an add-on, the project must be created with TypeScript.`);
         : {
             name: `${persistedOptions.projectName}-${mode}`,
             version: '0.0.1',
-            description: mode === 'add-on' ? 'Add-on' : 'Project starter',
+            description: mode === 'add-on' ? 'Add-on' : 'Project overlay',
             author: 'Jane Smith <jane.smith@example.com>',
             license: 'MIT',
             link: `https://github.com/jane-smith/${persistedOptions.projectName}-${mode}`,
             command: {},
             shadcnComponents: [],
-            framework: persistedOptions.framework,
             templates: [persistedOptions.mode],
             routes: [],
             warning: '',
@@ -174,7 +173,7 @@ To create an add-on, the project must be created with TypeScript.`);
             },
         };
     const compiledInfo = JSON.parse(JSON.stringify(info));
-    const originalOutput = await runCreateApp(await createAppOptionsFromPersisted(persistedOptions));
+    const originalOutput = await runCreateApp(await createOptions(persistedOptions));
     const originalPackageJson = JSON.parse(originalOutput.files[resolve(process.cwd(), 'package.json')]);
     const currentPackageJson = JSON.parse((await readFile('package.json')).toString());
     for (const script of Object.keys(currentPackageJson.scripts)) {
@@ -202,7 +201,7 @@ To create an add-on, the project must be created with TypeScript.`);
     // Find altered files
     const changedFiles = {};
     await compareFiles('.', IGNORE_FILES, originalOutput.files, changedFiles);
-    if (mode === 'starter') {
+    if (mode === 'overlay') {
         compiledInfo.files = changedFiles;
     }
     else {
@@ -236,8 +235,7 @@ To create an add-on, the project must be created with TypeScript.`);
     compiledInfo.routes = info.routes;
     compiledInfo.framework = persistedOptions.framework;
     compiledInfo.addDependencies = persistedOptions.existingAddOns;
-    compiledInfo.packageAdditions = info.packageAdditions;
-    if (mode === 'starter') {
+    if (mode === 'overlay') {
         compiledInfo.mode = persistedOptions.mode;
         compiledInfo.typescript = persistedOptions.typescript;
         compiledInfo.tailwind = persistedOptions.tailwind;

package/dist/index.js

@@ -1,5 +1 @@
 export { cli } from './cli.js';
-export { getAllAddOns } from './add-ons.js';
-export { createApp } from './create-app.js';
-export { createAppOptionsFromPersisted } from './custom-add-on.js';
-export { createMemoryEnvironment, createDefaultEnvironment, } from './environment.js';

package/dist/options.js

@@ -4,7 +4,7 @@ import { DEFAULT_TOOLCHAIN, SUPPORTED_TOOLCHAINS } from './toolchain.js';
 import { CODE_ROUTER, DEFAULT_FRAMEWORK, FILE_ROUTER } from './constants.js';
 import { finalizeAddOns, getAllAddOns, loadRemoteAddOn } from './add-ons.js';
 // If all CLI options are provided, use them directly
-export async function normalizeOptions(cliOptions, forcedAddOns) {
+export async function normalizeOptions(cliOptions, forcedMode, forcedAddOns) {
     // in some cases, if you use windows/powershell, the argument for addons
     // if sepparated by comma is not really passed as an array, but as a string
     // with spaces, We need to normalize this edge case.
@@ -23,22 +23,22 @@ export async function normalizeOptions(cliOptions, forcedAddOns) {
             tailwind = true;
         }
         let mode = cliOptions.template === 'file-router' ? FILE_ROUTER : CODE_ROUTER;
-        const starter = cliOptions.starter
-            ? (await loadRemoteAddOn(cliOptions.starter))
+        const overlay = cliOptions.overlay
+            ? (await loadRemoteAddOn(cliOptions.overlay))
             : undefined;
-        if (starter) {
-            tailwind = starter.tailwind;
-            typescript = starter.typescript;
-            cliOptions.framework = starter.framework;
-            mode = starter.mode;
+        if (overlay) {
+            tailwind = overlay.tailwind;
+            typescript = overlay.typescript;
+            cliOptions.framework = overlay.framework;
+            mode = overlay.mode;
         }
         let addOns = false;
         let chosenAddOns = [];
         if (Array.isArray(cliOptions.addOns) ||
-            starter?.dependsOn ||
+            overlay?.dependsOn ||
             forcedAddOns) {
             addOns = true;
-            let finalAddOns = Array.from(new Set([...(starter?.dependsOn || []), ...(forcedAddOns || [])]));
+            let finalAddOns = Array.from(new Set([...(overlay?.dependsOn || []), ...(forcedAddOns || [])]));
             if (cliOptions.addOns && Array.isArray(cliOptions.addOns)) {
                 finalAddOns = Array.from(new Set([
                     ...(forcedAddOns || []),
@@ -46,7 +46,9 @@ export async function normalizeOptions(cliOptions, forcedAddOns) {
                     ...cliOptions.addOns,
                 ]));
             }
-            chosenAddOns = await finalizeAddOns(cliOptions.framework || DEFAULT_FRAMEWORK, cliOptions.template === 'file-router' ? FILE_ROUTER : CODE_ROUTER, finalAddOns);
+            chosenAddOns = await finalizeAddOns(cliOptions.framework || DEFAULT_FRAMEWORK, forcedMode || cliOptions.template === 'file-router'
+                ? FILE_ROUTER
+                : CODE_ROUTER, finalAddOns);
             tailwind = true;
             typescript = true;
         }
@@ -64,7 +66,7 @@ export async function normalizeOptions(cliOptions, forcedAddOns) {
             addOns,
             chosenAddOns,
             variableValues: {},
-            starter,
+            overlay,
         };
     }
 }

package/dist/types/cli.d.ts

@@ -1,6 +1,7 @@
+import type { Mode } from './types.js';
 export declare function cli({ name, appName, forcedMode, forcedAddOns, }: {
     name: string;
     appName: string;
-    forcedMode?: 'typescript' | 'javascript' | 'file-router';
+    forcedMode?: Mode;
     forcedAddOns?: Array<string>;
 }): void;

package/dist/types/custom-add-on.d.ts

@@ -1,6 +1,3 @@
-import type { Options } from './types.js';
-import type { PersistedOptions } from './config-file.js';
-type AddOnMode = 'add-on' | 'starter';
-export declare function createAppOptionsFromPersisted(json: PersistedOptions): Promise<Required<Options>>;
+type AddOnMode = 'add-on' | 'overlay';
 export declare function initAddOn(mode: AddOnMode): Promise<void>;
 export {};

package/dist/types/index.d.ts

@@ -1,7 +1 @@
 export { cli } from './cli.js';
-export { getAllAddOns } from './add-ons.js';
-export { createApp } from './create-app.js';
-export { createAppOptionsFromPersisted } from './custom-add-on.js';
-export { createMemoryEnvironment, createDefaultEnvironment, } from './environment.js';
-export type { AddOn, Framework, Mode } from './types.js';
-export type { PersistedOptions } from './config-file.js';

package/dist/types/options.d.ts

@@ -1,6 +1,6 @@
-import type { CliOptions, Options } from './types.js';
-export declare function normalizeOptions(cliOptions: CliOptions, forcedAddOns?: Array<string>): Promise<Options | undefined>;
+import type { CliOptions, Mode, Options, TemplateOptions } from './types.js';
+export declare function normalizeOptions(cliOptions: CliOptions, forcedMode?: Mode, forcedAddOns?: Array<string>): Promise<Options | undefined>;
 export declare function promptForOptions(cliOptions: CliOptions, { forcedAddOns, forcedMode, }: {
     forcedAddOns?: Array<string>;
-    forcedMode?: 'typescript' | 'javascript' | 'file-router';
+    forcedMode?: TemplateOptions;
 }): Promise<Required<Options>>;

package/dist/types/types.d.ts

@@ -16,7 +16,7 @@ export interface Options {
     chosenAddOns: Array<AddOn>;
     git: boolean;
     variableValues: Record<string, string | number | boolean>;
-    starter?: AddOn | undefined;
+    overlay?: AddOn | undefined;
 }
 export interface CliOptions {
     template?: TemplateOptions;
@@ -30,7 +30,7 @@ export interface CliOptions {
     listAddOns?: boolean;
     mcp?: boolean;
     mcpSse?: boolean;
-    starter?: string;
+    overlay?: string;
     targetDir?: string;
 }
 export type Environment = {
@@ -70,7 +70,7 @@ export type AddOn = {
     id: string;
     name: string;
     description: string;
-    type: 'add-on' | 'example' | 'starter';
+    type: 'add-on' | 'example' | 'overlay';
     link: string;
     templates: Array<string>;
     routes: Array<{
@@ -95,8 +95,8 @@ export type AddOn = {
     files?: Record<string, string>;
     deletedFiles?: Array<string>;
 };
-export type Starter = AddOn & {
-    type: 'starter';
+export type Overlay = AddOn & {
+    type: 'overlay';
     version: string;
     author: string;
     link: string;

package/package.json

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

package/src/cli.ts

@@ -9,14 +9,14 @@ import { SUPPORTED_TOOLCHAINS } from './toolchain.js'
 import runServer from './mcp.js'
 import { listAddOns } from './add-ons.js'
 import { DEFAULT_FRAMEWORK, SUPPORTED_FRAMEWORKS } from './constants.js'
-import { initAddOn } from './custom-add-on.js'
+// import { initAddOn } from './custom-add-on.js'
 
 import { createDefaultEnvironment } from './environment.js'
-import { add } from './add.js'
+// import { add } from './add.js'
 
 import type { PackageManager } from './package-manager.js'
 import type { ToolChain } from './toolchain.js'
-import type { CliOptions, Framework } from './types.js'
+import type { CliOptions, Framework, Mode, TemplateOptions } from './types.js'
 
 export function cli({
   name,
@@ -26,33 +26,33 @@ export function cli({
 }: {
   name: string
   appName: string
-  forcedMode?: 'typescript' | 'javascript' | 'file-router'
+  forcedMode?: Mode
   forcedAddOns?: Array<string>
 }) {
   const program = new Command()
 
   program.name(name).description(`CLI to create a new ${appName} application`)
 
-  program
-    .command('add')
-    .argument('add-on', 'Name of the add-on (or add-ons separated by commas)')
-    .action(async (addOn: string) => {
-      await add(addOn.split(',').map((addon) => addon.trim()))
-    })
+  // program
+  //   .command('add')
+  //   .argument('add-on', 'Name of the add-on (or add-ons separated by commas)')
+  //   .action(async (addOn: string) => {
+  //     await add(addOn.split(',').map((addon) => addon.trim()))
+  //   })
 
-  program
-    .command('update-add-on')
-    .description('Create or update an add-on from the current project')
-    .action(async () => {
-      await initAddOn('add-on')
-    })
+  // program
+  //   .command('update-add-on')
+  //   .description('Create or update an add-on from the current project')
+  //   .action(async () => {
+  //     await initAddOn('add-on')
+  //   })
 
-  program
-    .command('update-starter')
-    .description('Create or update a project starter from the current project')
-    .action(async () => {
-      await initAddOn('starter')
-    })
+  // program
+  //   .command('update-overlay')
+  //   .description('Create or update a project overlay from the current project')
+  //   .action(async () => {
+  //     await initAddOn('overlay')
+  //   })
 
   program.argument('[project-name]', 'name of the project')
 
@@ -90,11 +90,7 @@ export function cli({
       },
       DEFAULT_FRAMEWORK,
     )
-    .option(
-      '--starter [url]',
-      'initialize this project from a starter URL',
-      false,
-    )
+    // .option('--overlay [url]', 'add an overlay from a URL', false)
     .option<PackageManager>(
       `--package-manager <${SUPPORTED_PACKAGE_MANAGERS.join('|')}>`,
       `Explicitly tell the CLI to use this package manager`,
@@ -147,12 +143,12 @@ export function cli({
   program.action(async (projectName: string, options: CliOptions) => {
     if (options.listAddOns) {
       await listAddOns(options, {
-        forcedMode,
+        forcedMode: forcedMode as TemplateOptions,
         forcedAddOns,
       })
     } else if (options.mcp || options.mcpSse) {
       await runServer(!!options.mcpSse, {
-        forcedMode,
+        forcedMode: forcedMode as TemplateOptions,
         forcedAddOns,
         appName,
       })
@@ -164,16 +160,20 @@ export function cli({
         } as CliOptions
 
         if (forcedMode) {
-          cliOptions.template = forcedMode
+          cliOptions.template = forcedMode as TemplateOptions
         }
 
-        let finalOptions = await normalizeOptions(cliOptions, forcedAddOns)
+        let finalOptions = await normalizeOptions(
+          cliOptions,
+          forcedMode,
+          forcedAddOns,
+        )
         if (finalOptions) {
           intro(`Creating a new ${appName} app in ${projectName}...`)
         } else {
           intro(`Let's configure your ${appName} application`)
           finalOptions = await promptForOptions(cliOptions, {
-            forcedMode,
+            forcedMode: forcedMode as TemplateOptions,
             forcedAddOns,
           })
         }

package/src/create-app.ts

@@ -529,9 +529,9 @@ export async function createApp(
         }
       }
     }
-    if (options.starter) {
-      if (options.starter.shadcnComponents) {
-        for (const component of options.starter.shadcnComponents) {
+    if (options.overlay) {
+      if (options.overlay.shadcnComponents) {
+        for (const component of options.overlay.shadcnComponents) {
           shadcnComponents.add(component)
         }
       }
@@ -714,11 +714,11 @@ export async function createApp(
   // Create the README.md
   await templateFile(templateDirBase, 'README.md.ejs')
 
-  // Adding starter
-  if (options.starter) {
-    s?.start(`Setting up starter ${options.starter.name}...`)
-    await runAddOn(options.starter)
-    s?.stop(`Starter ${options.starter.name} setup complete`)
+  // Adding overlay
+  if (options.overlay) {
+    s?.start(`Setting up overlay ${options.overlay.name}...`)
+    await runAddOn(options.overlay)
+    s?.stop(`Overlay ${options.overlay.name} setup complete`)
   }
 
   // Install dependencies
@@ -799,6 +799,6 @@ Use the following commands to start your app:
 % cd ${options.projectName}
 % ${startCommand}
 
-Please check the README.md for more information on testing, styling, adding routes, react-query, etc.${errorStatement}`)
+Please read the README.md for more information on testing, styling, adding routes, react-query, etc.${errorStatement}`)
   }
 }

package/src/custom-add-on.ts

@@ -12,15 +12,15 @@ import { readFileHelper } from './file-helper.js'
 import type { Framework, Options } from './types.js'
 import type { PersistedOptions } from './config-file.js'
 
-type AddOnMode = 'add-on' | 'starter'
+type AddOnMode = 'add-on' | 'overlay'
 
 const INFO_FILE: Record<AddOnMode, string> = {
   'add-on': '.add-on/info.json',
-  starter: 'starter-info.json',
+  overlay: 'overlay-info.json',
 }
 const COMPILED_FILE: Record<AddOnMode, string> = {
   'add-on': 'add-on.json',
-  starter: 'starter.json',
+  overlay: 'overlay.json',
 }
 
 const ADD_ON_DIR = '.add-on'
@@ -102,7 +102,7 @@ export default (parentRoute: RootRoute) => createRoute({
   return { url: path, code, name }
 }
 
-export async function createAppOptionsFromPersisted(
+async function createOptions(
   json: PersistedOptions,
 ): Promise<Required<Options>> {
   return {
@@ -198,13 +198,12 @@ To create an add-on, the project must be created with TypeScript.`)
     : {
         name: `${persistedOptions.projectName}-${mode}`,
         version: '0.0.1',
-        description: mode === 'add-on' ? 'Add-on' : 'Project starter',
+        description: mode === 'add-on' ? 'Add-on' : 'Project overlay',
         author: 'Jane Smith <jane.smith@example.com>',
         license: 'MIT',
         link: `https://github.com/jane-smith/${persistedOptions.projectName}-${mode}`,
         command: {},
         shadcnComponents: [],
-        framework: persistedOptions.framework,
         templates: [persistedOptions.mode],
         routes: [],
         warning: '',
@@ -221,7 +220,7 @@ To create an add-on, the project must be created with TypeScript.`)
   const compiledInfo = JSON.parse(JSON.stringify(info))
 
   const originalOutput = await runCreateApp(
-    await createAppOptionsFromPersisted(persistedOptions),
+    await createOptions(persistedOptions),
   )
 
   const originalPackageJson = JSON.parse(
@@ -265,7 +264,7 @@ To create an add-on, the project must be created with TypeScript.`)
   // Find altered files
   const changedFiles: Record<string, string> = {}
   await compareFiles('.', IGNORE_FILES, originalOutput.files, changedFiles)
-  if (mode === 'starter') {
+  if (mode === 'overlay') {
     compiledInfo.files = changedFiles
   } else {
     const assetsDir = resolve(ADD_ON_DIR, ASSETS_DIR)
@@ -303,9 +302,8 @@ To create an add-on, the project must be created with TypeScript.`)
   compiledInfo.routes = info.routes
   compiledInfo.framework = persistedOptions.framework
   compiledInfo.addDependencies = persistedOptions.existingAddOns
-  compiledInfo.packageAdditions = info.packageAdditions
 
-  if (mode === 'starter') {
+  if (mode === 'overlay') {
     compiledInfo.mode = persistedOptions.mode
     compiledInfo.typescript = persistedOptions.typescript
     compiledInfo.tailwind = persistedOptions.tailwind

package/src/index.ts

@@ -1,11 +1 @@
 export { cli } from './cli.js'
-export { getAllAddOns } from './add-ons.js'
-export { createApp } from './create-app.js'
-export { createAppOptionsFromPersisted } from './custom-add-on.js'
-export {
-  createMemoryEnvironment,
-  createDefaultEnvironment,
-} from './environment.js'
-
-export type { AddOn, Framework, Mode } from './types.js'
-export type { PersistedOptions } from './config-file.js'