@tanstack/cta-engine 0.32.3 → 0.33.3

package/dist/add-ons.js

@@ -1,6 +1,13 @@
 import { loadRemoteAddOn } from './custom-add-ons/add-on.js';
 export function getAllAddOns(framework, mode) {
-    return framework.getAddOns().filter((a) => a.modes.includes(mode));
+    return framework
+        .getAddOns()
+        .filter((a) => a.modes.includes(mode))
+        .sort((a, b) => {
+        const aPriority = a.priority ?? 0;
+        const bPriority = b.priority ?? 0;
+        return bPriority - aPriority; // Higher priority first
+    });
 }
 // Turn the list of chosen add-on IDs into a final list of add-ons by resolving dependencies
 export async function finalizeAddOns(framework, mode, chosenAddOnIDs) {

package/dist/create-app.js

@@ -182,7 +182,7 @@ Use the following commands to start your app:
 % cd ${options.projectName}
 % ${formatCommand(getPackageManagerScriptCommand(options.packageManager, ['dev']))}
 
-Please read the README.md for information on testing, styling, adding routes, etc.${errorStatement}`);
+Please check the README.md for information on testing, styling, adding routes, etc.${errorStatement}`);
 }
 export async function createApp(environment, options) {
     environment.startRun();

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

@@ -38,6 +38,7 @@ export declare function generateProject(persistedOptions: PersistedOptions): Pro
         link?: string | undefined;
         license?: string | undefined;
         warning?: string | undefined;
+        priority?: number | undefined;
         routes?: {
             path: string;
             jsName: string;

package/dist/types/types.d.ts

@@ -113,6 +113,7 @@ export declare const AddOnBaseSchema: z.ZodObject<{
     license: z.ZodOptional<z.ZodString>;
     warning: z.ZodOptional<z.ZodString>;
     type: z.ZodEnum<["add-on", "example", "starter", "toolchain", "host"]>;
+    priority: z.ZodOptional<z.ZodNumber>;
     command: z.ZodOptional<z.ZodObject<{
         command: z.ZodString;
         args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -219,6 +220,7 @@ export declare const AddOnBaseSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -262,6 +264,7 @@ export declare const AddOnBaseSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -291,6 +294,7 @@ export declare const StarterSchema: z.ZodObject<{
     license: z.ZodOptional<z.ZodString>;
     warning: z.ZodOptional<z.ZodString>;
     type: z.ZodEnum<["add-on", "example", "starter", "toolchain", "host"]>;
+    priority: z.ZodOptional<z.ZodNumber>;
     command: z.ZodOptional<z.ZodObject<{
         command: z.ZodString;
         args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -407,6 +411,7 @@ export declare const StarterSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -455,6 +460,7 @@ export declare const StarterSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -485,6 +491,7 @@ export declare const StarterCompiledSchema: z.ZodObject<{
     license: z.ZodOptional<z.ZodString>;
     warning: z.ZodOptional<z.ZodString>;
     type: z.ZodEnum<["add-on", "example", "starter", "toolchain", "host"]>;
+    priority: z.ZodOptional<z.ZodNumber>;
     command: z.ZodOptional<z.ZodObject<{
         command: z.ZodString;
         args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -606,6 +613,7 @@ export declare const StarterCompiledSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -656,6 +664,7 @@ export declare const StarterCompiledSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -705,6 +714,7 @@ export declare const AddOnInfoSchema: z.ZodObject<{
     license: z.ZodOptional<z.ZodString>;
     warning: z.ZodOptional<z.ZodString>;
     type: z.ZodEnum<["add-on", "example", "starter", "toolchain", "host"]>;
+    priority: z.ZodOptional<z.ZodNumber>;
     command: z.ZodOptional<z.ZodObject<{
         command: z.ZodString;
         args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -836,6 +846,7 @@ export declare const AddOnInfoSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -889,6 +900,7 @@ export declare const AddOnInfoSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -926,6 +938,7 @@ export declare const AddOnCompiledSchema: z.ZodObject<{
     license: z.ZodOptional<z.ZodString>;
     warning: z.ZodOptional<z.ZodString>;
     type: z.ZodEnum<["add-on", "example", "starter", "toolchain", "host"]>;
+    priority: z.ZodOptional<z.ZodNumber>;
     command: z.ZodOptional<z.ZodObject<{
         command: z.ZodString;
         args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -1063,6 +1076,7 @@ export declare const AddOnCompiledSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;
@@ -1119,6 +1133,7 @@ export declare const AddOnCompiledSchema: z.ZodObject<{
     link?: string | undefined;
     license?: string | undefined;
     warning?: string | undefined;
+    priority?: number | undefined;
     routes?: {
         path: string;
         jsName: string;

package/dist/types.js

@@ -23,6 +23,7 @@ export const AddOnBaseSchema = z.object({
     license: z.string().optional(),
     warning: z.string().optional(),
     type: z.enum(['add-on', 'example', 'starter', 'toolchain', 'host']),
+    priority: z.number().optional(),
     command: z
         .object({
         command: z.string(),

package/package.json

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

package/src/add-ons.ts

@@ -3,7 +3,14 @@ import { loadRemoteAddOn } from './custom-add-ons/add-on.js'
 import type { AddOn, Framework } from './types.js'
 
 export function getAllAddOns(framework: Framework, mode: string): Array<AddOn> {
-  return framework.getAddOns().filter((a) => a.modes.includes(mode))
+  return framework
+    .getAddOns()
+    .filter((a) => a.modes.includes(mode))
+    .sort((a, b) => {
+      const aPriority = a.priority ?? 0
+      const bPriority = b.priority ?? 0
+      return bPriority - aPriority // Higher priority first
+    })
 }
 
 // Turn the list of chosen add-on IDs into a final list of add-ons by resolving dependencies
@@ -49,10 +56,10 @@ function loadAddOn(addOn: AddOn): AddOn {
 }
 
 export function populateAddOnOptionsDefaults(
-  chosenAddOns: Array<AddOn>
+  chosenAddOns: Array<AddOn>,
 ): Record<string, Record<string, any>> {
   const addOnOptions: Record<string, Record<string, any>> = {}
-  
+
   for (const addOn of chosenAddOns) {
     if (addOn.options) {
       const defaults: Record<string, any> = {}
@@ -62,6 +69,6 @@ export function populateAddOnOptionsDefaults(
       addOnOptions[addOn.id] = defaults
     }
   }
-  
+
   return addOnOptions
 }

package/src/create-app.ts

@@ -251,7 +251,7 @@ Use the following commands to start your app:
       getPackageManagerScriptCommand(options.packageManager, ['dev']),
     )}
 
-Please read the README.md for information on testing, styling, adding routes, etc.${errorStatement}`,
+Please check the README.md for information on testing, styling, adding routes, etc.${errorStatement}`,
   )
 }
 

package/src/types.ts

@@ -38,6 +38,7 @@ export const AddOnBaseSchema = z.object({
   license: z.string().optional(),
   warning: z.string().optional(),
   type: z.enum(['add-on', 'example', 'starter', 'toolchain', 'host']),
+  priority: z.number().optional(),
   command: z
     .object({
       command: z.string(),

package/tests/add-ons.test.ts

@@ -28,6 +28,79 @@ describe('getAllAddOns', () => {
     expect(addOns.length).toEqual(1)
     expect(addOns[0].id).toEqual('add-on-1')
   })
+
+  it('should sort add-ons by priority (higher priority first)', () => {
+    const addOns = getAllAddOns(
+      {
+        id: 'react-cra',
+        getAddOns: () => [
+          {
+            id: 'low-priority',
+            description: 'Low Priority',
+            modes: ['file-router'],
+            priority: 10,
+          } as AddOn,
+          {
+            id: 'high-priority',
+            description: 'High Priority',
+            modes: ['file-router'],
+            priority: 100,
+          } as AddOn,
+          {
+            id: 'no-priority',
+            description: 'No Priority (defaults to 0)',
+            modes: ['file-router'],
+          } as AddOn,
+          {
+            id: 'medium-priority',
+            description: 'Medium Priority',
+            modes: ['file-router'],
+            priority: 50,
+          } as AddOn,
+        ],
+      } as Framework,
+      'file-router',
+    )
+
+    expect(addOns.length).toEqual(4)
+    expect(addOns[0].id).toEqual('high-priority')
+    expect(addOns[1].id).toEqual('medium-priority')
+    expect(addOns[2].id).toEqual('low-priority')
+    expect(addOns[3].id).toEqual('no-priority')
+  })
+
+  it('should filter by mode and then sort by priority', () => {
+    const addOns = getAllAddOns(
+      {
+        id: 'react-cra',
+        getAddOns: () => [
+          {
+            id: 'file-router-low',
+            description: 'File Router Low',
+            modes: ['file-router'],
+            priority: 20,
+          } as AddOn,
+          {
+            id: 'code-router-high',
+            description: 'Code Router High (should be filtered out)',
+            modes: ['code-router'],
+            priority: 200,
+          } as AddOn,
+          {
+            id: 'file-router-high',
+            description: 'File Router High',
+            modes: ['file-router'],
+            priority: 100,
+          } as AddOn,
+        ],
+      } as Framework,
+      'file-router',
+    )
+
+    expect(addOns.length).toEqual(2)
+    expect(addOns[0].id).toEqual('file-router-high')
+    expect(addOns[1].id).toEqual('file-router-low')
+  })
 })
 
 describe('finalizeAddOns', () => {