create-fluxstack 1.0.0

package/core/plugins/built-in/static/index.ts

@@ -0,0 +1,289 @@
+import { join, extname } from "path"
+import { existsSync, statSync } from "fs"
+import type { Plugin, PluginContext } from "../../types"
+
+export const staticPlugin: Plugin = {
+  name: "static",
+  version: "1.0.0",
+  description: "Enhanced static file serving plugin for FluxStack with caching and compression",
+  author: "FluxStack Team",
+  priority: "low", // Should run after other plugins
+  category: "core",
+  tags: ["static", "files", "spa"],
+  dependencies: [], // No hard dependencies, but works with vite plugin
+  
+  configSchema: {
+    type: "object",
+    properties: {
+      enabled: {
+        type: "boolean",
+        description: "Enable static file serving"
+      },
+      publicDir: {
+        type: "string",
+        description: "Public directory for static files"
+      },
+      distDir: {
+        type: "string", 
+        description: "Distribution directory for built files"
+      },
+      indexFile: {
+        type: "string",
+        description: "Index file for SPA routing"
+      },
+      cacheControl: {
+        type: "object",
+        properties: {
+          enabled: { type: "boolean" },
+          maxAge: { type: "number" },
+          immutable: { type: "boolean" }
+        },
+        description: "Cache control settings"
+      },
+      compression: {
+        type: "object",
+        properties: {
+          enabled: { type: "boolean" },
+          types: {
+            type: "array",
+            items: { type: "string" }
+          }
+        },
+        description: "Compression settings"
+      },
+      spa: {
+        type: "object",
+        properties: {
+          enabled: { type: "boolean" },
+          fallback: { type: "string" }
+        },
+        description: "Single Page Application settings"
+      },
+      excludePaths: {
+        type: "array",
+        items: { type: "string" },
+        description: "Paths to exclude from static serving"
+      }
+    },
+    additionalProperties: false
+  },
+  
+  defaultConfig: {
+    enabled: true,
+    publicDir: "public",
+    distDir: "dist/client",
+    indexFile: "index.html",
+    cacheControl: {
+      enabled: true,
+      maxAge: 31536000, // 1 year for assets
+      immutable: true
+    },
+    compression: {
+      enabled: true,
+      types: [".js", ".css", ".html", ".json", ".svg"]
+    },
+    spa: {
+      enabled: true,
+      fallback: "index.html"
+    },
+    excludePaths: []
+  },
+
+  setup: async (context: PluginContext) => {
+    const config = getPluginConfig(context)
+    
+    if (!config.enabled) {
+      context.logger.info('Static files plugin disabled by configuration')
+      return
+    }
+
+    context.logger.info("Enhanced static files plugin activated", {
+      publicDir: config.publicDir,
+      distDir: config.distDir,
+      spa: config.spa.enabled,
+      compression: config.compression.enabled
+    })
+    
+    // Setup static file handling in Elysia
+    context.app.get("/*", async ({ request, set }: { request: Request, set: any }) => {
+      const url = new URL(request.url)
+      
+      // Skip API routes
+      if (url.pathname.startsWith(context.config.server.apiPrefix)) {
+        return
+      }
+      
+      // Skip excluded paths
+      if (config.excludePaths.some((path: string) => url.pathname.startsWith(path))) {
+        return
+      }
+      
+      try {
+        // Note: Vite proxy is now handled by the Vite plugin via onBeforeRoute hook
+        // This plugin only handles static files serving in production or fallback
+        
+        // Serve static files
+        return await serveStaticFile(url.pathname, config, context, set)
+        
+      } catch (error) {
+        context.logger.error("Error serving static file", { 
+          path: url.pathname, 
+          error: error instanceof Error ? error.message : String(error)
+        })
+        
+        set.status = 500
+        return "Internal Server Error"
+      }
+    })
+  },
+
+  onServerStart: async (context: PluginContext) => {
+    const config = getPluginConfig(context)
+    
+    if (config.enabled) {
+      const mode = context.utils.isDevelopment() ? 'development' : 'production'
+      context.logger.info(`Static files plugin ready in ${mode} mode`, {
+        publicDir: config.publicDir,
+        distDir: config.distDir,
+        spa: config.spa.enabled
+      })
+    }
+  }
+}
+
+// Helper function to get plugin config
+function getPluginConfig(context: PluginContext) {
+  const pluginConfig = context.config.plugins.config?.static || {}
+  return { ...staticPlugin.defaultConfig, ...pluginConfig }
+}
+
+// Serve static file
+async function serveStaticFile(
+  pathname: string, 
+  config: any, 
+  context: PluginContext,
+  set: any
+): Promise<any> {
+  const isDev = context.utils.isDevelopment()
+  
+  // Determine base directory using path discovery (no hardcoded detection)
+  let baseDir: string
+  
+  if (isDev && existsSync(config.publicDir)) {
+    // Development: use public directory
+    baseDir = config.publicDir
+  } else {
+    // Production: try paths in order of preference
+    if (existsSync('client')) {
+      // Found client/ in current directory (running from dist/)
+      baseDir = 'client'
+    } else if (existsSync('dist/client')) {
+      // Found dist/client/ (running from project root)
+      baseDir = 'dist/client'
+    } else {
+      // Fallback to configured path
+      baseDir = config.distDir
+    }
+  }
+  
+  if (!existsSync(baseDir)) {
+    context.logger.warn(`Static directory not found: ${baseDir}`)
+    set.status = 404
+    return "Not Found"
+  }
+  
+  // Clean pathname
+  const cleanPath = pathname === '/' ? `/${config.indexFile}` : pathname
+  const filePath = join(process.cwd(), baseDir, cleanPath)
+  
+  // Security check - prevent directory traversal
+  const resolvedPath = join(process.cwd(), baseDir)
+  if (!filePath.startsWith(resolvedPath)) {
+    set.status = 403
+    return "Forbidden"
+  }
+  
+  // Check if file exists
+  if (!existsSync(filePath)) {
+    // For SPA, serve index.html for non-file routes
+    if (config.spa.enabled && !pathname.includes('.')) {
+      const indexPath = join(process.cwd(), baseDir, config.spa.fallback)
+      if (existsSync(indexPath)) {
+        return serveFile(indexPath, config, set, context)
+      }
+    }
+    
+    set.status = 404
+    return "Not Found"
+  }
+  
+  // Check if it's a directory
+  const stats = statSync(filePath)
+  if (stats.isDirectory()) {
+    const indexPath = join(filePath, config.indexFile)
+    if (existsSync(indexPath)) {
+      return serveFile(indexPath, config, set, context)
+    }
+    
+    set.status = 404
+    return "Not Found"
+  }
+  
+  return serveFile(filePath, config, set, context)
+}
+
+// Serve individual file
+function serveFile(filePath: string, config: any, set: any, context: PluginContext) {
+  const ext = extname(filePath)
+  const file = Bun.file(filePath)
+  
+  // Set content type
+  const mimeTypes: Record<string, string> = {
+    '.html': 'text/html',
+    '.css': 'text/css',
+    '.js': 'application/javascript',
+    '.json': 'application/json',
+    '.png': 'image/png',
+    '.jpg': 'image/jpeg',
+    '.jpeg': 'image/jpeg',
+    '.gif': 'image/gif',
+    '.svg': 'image/svg+xml',
+    '.ico': 'image/x-icon',
+    '.woff': 'font/woff',
+    '.woff2': 'font/woff2',
+    '.ttf': 'font/ttf',
+    '.eot': 'application/vnd.ms-fontobject'
+  }
+  
+  const contentType = mimeTypes[ext] || 'application/octet-stream'
+  set.headers['Content-Type'] = contentType
+  
+  // Set cache headers
+  if (config.cacheControl.enabled) {
+    if (ext === '.html') {
+      // Don't cache HTML files aggressively
+      set.headers['Cache-Control'] = 'no-cache'
+    } else {
+      // Cache assets aggressively
+      const maxAge = config.cacheControl.maxAge
+      const cacheControl = config.cacheControl.immutable 
+        ? `public, max-age=${maxAge}, immutable`
+        : `public, max-age=${maxAge}`
+      set.headers['Cache-Control'] = cacheControl
+    }
+  }
+  
+  // Add compression hint if enabled
+  if (config.compression.enabled && config.compression.types.includes(ext)) {
+    set.headers['Vary'] = 'Accept-Encoding'
+  }
+  
+  context.logger.debug(`Serving static file: ${filePath}`, {
+    contentType,
+    size: file.size
+  })
+  
+  return file
+}
+
+export default staticPlugin

package/core/plugins/built-in/swagger/index.ts

@@ -0,0 +1,229 @@
+import { swagger } from '@elysiajs/swagger'
+import type { Plugin, PluginContext } from '../../types'
+
+export const swaggerPlugin: Plugin = {
+  name: 'swagger',
+  version: '1.0.0',
+  description: 'Enhanced Swagger documentation plugin for FluxStack with customizable options',
+  author: 'FluxStack Team',
+  priority: 'normal',
+  category: 'documentation',
+  tags: ['swagger', 'documentation', 'api'],
+  dependencies: [], // No dependencies
+  
+  configSchema: {
+    type: 'object',
+    properties: {
+      enabled: {
+        type: 'boolean',
+        description: 'Enable Swagger documentation'
+      },
+      path: {
+        type: 'string',
+        description: 'Swagger UI path'
+      },
+      title: {
+        type: 'string',
+        description: 'API documentation title'
+      },
+      description: {
+        type: 'string',
+        description: 'API documentation description'
+      },
+      version: {
+        type: 'string',
+        description: 'API version'
+      },
+      tags: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            name: { type: 'string' },
+            description: { type: 'string' }
+          },
+          required: ['name']
+        },
+        description: 'API tags for grouping endpoints'
+      },
+      servers: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            url: { type: 'string' },
+            description: { type: 'string' }
+          },
+          required: ['url']
+        },
+        description: 'API servers'
+      },
+      excludePaths: {
+        type: 'array',
+        items: { type: 'string' },
+        description: 'Paths to exclude from documentation'
+      },
+      securitySchemes: {
+        type: 'object',
+        description: 'Security schemes definition'
+      },
+      globalSecurity: {
+        type: 'array',
+        items: {
+          type: 'object'
+        },
+        description: 'Global security requirements'
+      }
+    },
+    additionalProperties: false
+  },
+  
+  defaultConfig: {
+    enabled: true,
+    path: '/swagger',
+    title: 'FluxStack API',
+    description: 'Modern full-stack TypeScript framework with type-safe API endpoints',
+    version: '1.0.0',
+    tags: [
+      { 
+        name: 'Health', 
+        description: 'Health check endpoints' 
+      },
+      { 
+        name: 'API', 
+        description: 'API endpoints' 
+      }
+    ],
+    servers: [],
+    excludePaths: [],
+    securitySchemes: {},
+    globalSecurity: []
+  },
+
+  setup: async (context: PluginContext) => {
+    const config = getPluginConfig(context)
+    
+    if (!config.enabled) {
+      context.logger.info('Swagger plugin disabled by configuration')
+      return
+    }
+
+    try {
+      // Build servers list
+      const servers = config.servers.length > 0 ? config.servers : [
+        {
+          url: `http://${context.config.server.host}:${context.config.server.port}`,
+          description: 'Development server'
+        }
+      ]
+
+      // Add production server if in production
+      if (context.utils.isProduction()) {
+        servers.push({
+          url: 'https://api.example.com', // This would be configured
+          description: 'Production server'
+        })
+      }
+
+      const swaggerConfig = {
+        path: config.path,
+        documentation: {
+          info: {
+            title: config.title || context.config.app?.name || 'FluxStack API',
+            version: config.version || context.config.app?.version || '1.0.0',
+            description: config.description || context.config.app?.description || 'Modern full-stack TypeScript framework with type-safe API endpoints'
+          },
+          tags: config.tags,
+          servers,
+          
+          // Add security schemes if defined
+          ...(Object.keys(config.securitySchemes).length > 0 && {
+            components: {
+              securitySchemes: config.securitySchemes
+            }
+          }),
+          
+          // Add global security if defined
+          ...(config.globalSecurity.length > 0 && {
+            security: config.globalSecurity
+          })
+        },
+        exclude: config.excludePaths,
+        swaggerOptions: {
+          persistAuthorization: true,
+          displayRequestDuration: true,
+          filter: true,
+          showExtensions: true,
+          tryItOutEnabled: true
+        }
+      }
+
+      context.app.use(swagger(swaggerConfig))
+      
+      context.logger.info(`Swagger documentation enabled at ${config.path}`, {
+        title: swaggerConfig.documentation.info.title,
+        version: swaggerConfig.documentation.info.version,
+        servers: servers.length
+      })
+    } catch (error) {
+      context.logger.error('Failed to setup Swagger plugin', { error })
+      throw error
+    }
+  },
+
+  onServerStart: async (context: PluginContext) => {
+    const config = getPluginConfig(context)
+    
+    if (config.enabled) {
+      const swaggerUrl = `http://${context.config.server.host}:${context.config.server.port}${config.path}`
+      context.logger.info(`Swagger documentation available at: ${swaggerUrl}`)
+    }
+  }
+}
+
+// Helper function to get plugin config from context
+function getPluginConfig(context: PluginContext) {
+  // In a real implementation, this would get the config from the plugin context
+  // For now, merge default config with any provided config
+  const pluginConfig = context.config.plugins.config?.swagger || {}
+  return { ...swaggerPlugin.defaultConfig, ...pluginConfig }
+}
+
+// Example usage for security configuration:
+// 
+// To enable security in your FluxStack app, configure like this:
+//
+// plugins: {
+//   config: {
+//     swagger: {
+//       securitySchemes: {
+//         bearerAuth: {
+//           type: 'http',
+//           scheme: 'bearer',
+//           bearerFormat: 'JWT'
+//         },
+//         apiKeyAuth: {
+//           type: 'apiKey',
+//           in: 'header',
+//           name: 'X-API-Key'
+//         }
+//       },
+//       globalSecurity: [
+//         { bearerAuth: [] }  // Apply JWT auth globally
+//       ]
+//     }
+//   }
+// }
+//
+// Then in your routes, you can override per endpoint:
+// app.get('/public', handler, {
+//   detail: { security: [] }  // No auth required
+// })
+//
+// app.get('/private', handler, {
+//   detail: { 
+//     security: [{ apiKeyAuth: [] }]  // API key required
+//   }
+// })
+
+export default swaggerPlugin