feat(upload-module): enforce storage provider requirement for upload module; update prompts and validation logic; enhance user guidance for storage selection

Author: muneebhashone

.claude/settings.local.json

@@ -31,7 +31,8 @@
       "Bash(if [ -d test-standard ])",
       "Bash(then rm -rf test-standard)",
       "Bash(rm:*)",
-      "Bash(mkdir:*)"
+      "Bash(mkdir:*)",
+      "Bash(pnpm --filter create-tbk-app typecheck:*)"
     ],
     "deny": [],
     "ask": []

packages/create-tbk-app/src/cli.ts

@@ -314,6 +314,13 @@ async function validateAndAdjustConfig(
     throw new Error(`Invalid project name: ${validation.error}`);
   }
 
+  // Validate upload module requires storage provider
+  if (config.modules?.includes('upload') && config.storage === 'none') {
+    throw new Error(
+      'The upload module requires a storage provider. Please select a storage provider (local, s3, or r2) when using the upload module.',
+    );
+  }
+
   return resolveProjectDirectory(config, options, interactive);
 }
 

packages/create-tbk-app/src/prompts.ts

@@ -92,6 +92,25 @@ export async function collectProjectConfig(
   const agentOptions = await collectAgentOptions(defaults);
   const moduleOptions = await collectModuleOptions(defaults);
 
+  // Check if upload module is selected but storage is 'none'
+  let storage = customConfig.storage!;
+  if (moduleOptions.includes('upload') && storage === 'none') {
+    note(
+      'The upload module requires a storage provider to function properly.',
+      'Storage provider required',
+    );
+
+    storage = await promptSelectValue<StorageProvider>({
+      message: 'Select a storage provider for file uploads',
+      options: [
+        { label: 'Local – Store files on disk', value: 'local' },
+        { label: 'AWS S3 – Amazon S3', value: 's3' },
+        { label: 'Cloudflare R2 – S3 compatible', value: 'r2' },
+      ],
+      initialValue: 'local',
+    });
+  }
+
   const finalConfig: ProjectConfig = {
     projectName,
     preset,
@@ -101,7 +120,7 @@ export async function collectProjectConfig(
     cache: customConfig.cache!,
     queues: customConfig.queues ?? false,
     queueDashboard: customConfig.queueDashboard ?? false,
-    storage: customConfig.storage!,
+    storage,
     email: customConfig.email!,
     realtime: customConfig.realtime ?? false,
     admin: customConfig.admin ?? false,
@@ -204,7 +223,7 @@ async function collectCustomConfig(
   const storage = await promptSelectValue<StorageProvider>({
     message: 'File storage provider',
     options: [
-      { label: 'None – No file uploads', value: 'none' },
+      { label: 'None – No file uploads', value: 'none', hint: 'Upload module will not be available' },
       { label: 'Local – Store files on disk', value: 'local' },
       { label: 'AWS S3 – Amazon S3', value: 's3' },
       { label: 'Cloudflare R2 – S3 compatible', value: 'r2' },
@@ -318,7 +337,7 @@ async function collectModuleOptions(
       {
         label: 'Upload',
         value: 'upload',
-        hint: 'File upload example module',
+        hint: 'File upload example module (requires storage provider)',
       },
       {
         label: 'Healthcheck',

packages/create-tbk-app/templates/base/src/plugins/lifecycle/index.ts renamed to packages/create-tbk-app/templates/base/src/plugins/lifecycle/index.ts.hbs

@@ -1,7 +1,9 @@
 import type { ToolkitPlugin, PluginFactory } from '@/plugins/types';
 import { LifecycleManager, type LifecycleOptions } from './lifecycle-manager';
 import { disconnectDatabase } from '@/lib/database';
+{{#if REALTIME}}
 import { Server as SocketServer } from 'socket.io';
+{{/if}}
 import { cacheProvider, RedisProvider } from '@/lib/cache';
 import { closeAllQueues } from '@/lib/queue';
 
@@ -26,8 +28,10 @@ export const lifecyclePlugin: PluginFactory<LifecycleOptions> = (
         if (cacheProvider instanceof RedisProvider) {
           await cacheProvider.getClient().quit();
         }
+{{#if REALTIME}}
         const io = app.locals?.io as SocketServer | undefined;
         io?.disconnectSockets(true);
+{{/if}}
       });
 
       lifecycle.setupSignalHandlers();

packages/create-tbk-app/templates/base/src/plugins/logger/index.ts.hbs

@@ -211,11 +211,7 @@ export const loggerPlugin: PluginFactory<LoggerOptions> = (
       // Register HTTP logging middleware
       app.use(httpLogger);
 
-      logger.debug('Logger plugin registered', {
-        level: options.level || defaultLogLevel,
-        pretty: options.pretty !== undefined ? options.pretty : isDevelopment,
-        redact: options.redact?.length || 0,
-      });
+      logger.debug('Logger plugin registered');
 
       return [];
     },

packages/create-tbk-app/templates/base/src/routes/routes.ts.hbs

@@ -3,15 +3,15 @@ import express from 'express';
 import authRouter, { AUTH_ROUTER_ROOT } from '../modules/auth/auth.router';
 import userRouter, { USER_ROUTER_ROOT } from '../modules/user/user.router';
 {{/if}}
-{{#if (or OBSERVABILITY_FULL MODULE_HEALTHCHECK)}}
+{{#if (MODULE_HEALTHCHECK)}}
 import healthCheckRouter, {
   HEALTH_ROUTER_ROOT,
 } from '../modules/healthcheck/healthcheck.routes';
 {{/if}}
 
 const router = express.Router();
 
-{{#if (or OBSERVABILITY_FULL MODULE_HEALTHCHECK)}}
+{{#if (MODULE_HEALTHCHECK)}}
 router.use(HEALTH_ROUTER_ROOT, healthCheckRouter);
 {{/if}}
 {{#if AUTH}}

packages/create-tbk-app/templates/base/src/types.ts.hbs

@@ -1,5 +1,7 @@
 import type { Request, Response } from 'express';
+{{#if REALTIME}}
 import type { Server } from 'socket.io';
+{{/if}}
 import type { AnyZodObject, ZodEffects, ZodSchema } from 'zod';
 {{#if AUTH_JWT}}
 import type { JwtPayload } from '@/utils/jwt.utils';