@title
\nAdministrator
\n @end\n\n - \n @each(friend in user.friends)\n
- \n @friend.name\n @if(friend.isClose)⭐@end\n \n @end\n
Total friends: @{user.friends.length}
\nThis content will be minified.
\n\n This preformatted text\n keeps its original spacing\n and line breaks exactly as written.\n\n \n
\n // JavaScript code example\n function example() {\n const x = 10;\n const y = 20;\n return x + y;\n }\n \nBack to normal minification
\n```\n\n**Inline skip markers:**\n```html\n\n\nMulti-line\n content with\n intentional spacing.
\nName: @name
\nAge: @age
\nEmail: @email
\n\nFirst item: @first
\nSecond item: @second
\n```\n\n### Function Calls\n\n```html\n@var formattedDate = formatDate(createdAt);\n@var fullName = getFullName(user.firstName, user.lastName);\n\nCreated: @formattedDate
\nWelcome, @fullName!
\n\n@if(isAdmin(user.role))\nWith tags
');\n});\n\napp.get('/json', (req, res) => {\n res.json({ message: 'JSON response', status: 'success' });\n});\n\n// Status codes\napp.get('/created', (req, res) => {\n res.status(201).send('Resource created');\n});\n\napp.get('/unauthorized', (req, res) => {\n res.status(401).json({ error: 'Authentication required' });\n});\n\n// Fluent interface\napp.get('/fluent', (req, res) => {\n res\n .status(200)\n .set({\n 'X-Custom-Header': 'value',\n 'Cache-Control': 'no-cache'\n })\n .json({ data: 'response' });\n});\n\n// Redirects\napp.get('/old-route', (req, res) => {\n res.redirect('/new-route');\n});\n\napp.get('/temporary', (req, res) => {\n res.redirect('/new-location', 307); // Status code can be specified\n});\n\n// Headers\napp.get('/custom-headers', (req, res) => {\n res.set({\n 'X-Custom-Header': 'value',\n 'Cache-Control': 'no-cache, no-store, must-revalidate'\n }).send('Headers set');\n});\n\n// Cookies\napp.get('/set-cookie', (req, res) => {\n res.cookie('sessionId', '12345', {\n httpOnly: true,\n maxAge: 24 * 60 * 60 * 1000\n });\n res.send('Cookie set');\n});\n```\n\n#### File Responses\n```javascript\n// Send file with automatic content-type\napp.get('/download-pdf', (req, res) => {\n app.sendFile('./documents/report.pdf', res);\n});\n\n// Explicit content-type\napp.get('/download-csv', (req, res) => {\n app.sendFile('./data/export.csv', 'text/csv', res);\n});\n\n// Alternative syntax\napp.get('/manual-file', (req, res) => {\n const filePath = path.join(__dirname, 'files', 'manual.pdf');\n app.sendFile(filePath, 'application/pdf', res);\n});\n\n// With error handling\napp.get('/download', (req, res) => {\n try {\n app.sendFile('./important.docx', res);\n } catch (err) {\n res.status(500).send('Failed to download file');\n }\n});\n```\n\n### Cookie Management\n\n#### Setting Cookies\n```javascript\n// Basic cookie\nres.cookie('username', 'john_doe');\n\n// With options\nres.cookie('session', 'abc123', {\n maxAge: 24 * 60 * 60 * 1000, // 1 day\n httpOnly: true,\n secure: true,\n domain: 'example.com',\n path: '/admin',\n sameSite: 'strict'\n});\n\n// Multiple cookies\nres.cookie('preferences', 'dark_mode')\n .cookie('language', 'en');\n```\n\n#### Reading Cookies\n```javascript\napp.get('/dashboard', (req, res) => {\n // All cookies are available in req.cookies\n const session = req.cookies.session;\n const preferences = req.cookies.preferences;\n\n if (!session) {\n return res.redirect('/login');\n }\n\n // Use cookie values\n res.send(`Preferences: \\${preferences}`);\n});\n```\n\n#### Clearing Cookies\n```javascript\napp.get('/logout', (req, res) => {\n // Clear specific cookie\n req.clearCookie('session');\n\n // Clear with options (must match original cookie options)\n req.clearCookie('preferences', {\n domain: 'example.com',\n path: '/admin'\n });\n\n res.redirect('/login');\n});\n```\n\n### Middleware System\n\n#### Application-Level Middleware\n```javascript\n// Runs for every request\napp.useMiddleware((req, res, next) => {\n console.log('Request received at', new Date());\n next(); // Pass control to next middleware\n});\n\n// Conditional middleware\napp.useMiddleware((req, res, next) => {\n if (req.path.startsWith('/api')) {\n req.apiRequest = true;\n }\n next();\n});\n\n// Async middleware\napp.useMiddleware(async (req, res, next) => {\n try {\n req.user = await User.findByToken(req.headers.authorization);\n next();\n } catch (err) {\n next(err); // Pass to error handlers\n }\n});\n\n// Body parsing middleware\napp.useMiddleware((req, res, next) => {\n if (req.method === 'POST' && !req.headers['content-type']) {\n req.headers['content-type'] = 'application/json';\n }\n next();\n});\n```\n\n#### Error Handling Middleware\n```javascript\n// Basic error handler\napp.useErrorMiddleware((err, req, res, next) => {\n console.error('Error:', err);\n res.status(500).send('Something went wrong');\n});\n\n// Status code specific\napp.useErrorMiddleware((err, req, res, next) => {\n if (err.statusCode === 404) {\n res.status(404).send('Custom not found message');\n } else {\n next(err); // Pass to next error handler\n }\n});\n\n// Production vs development\napp.useErrorMiddleware((err, req, res, next) => {\n const response = {\n message: err.message\n };\n\n if (process.env.NODE_ENV === 'development') {\n response.stack = err.stack;\n }\n\n res.status(err.status || 500).json(response);\n});\n\n// File upload error handling\napp.useErrorMiddleware((err, req, res, next) => {\n if (err.code === 'LIMIT_FILE_SIZE') {\n res.status(413).json({ error: 'File too large' });\n } else if (err.code === 'INVALID_FILE_TYPE') {\n res.status(415).json({ error: 'Invalid file type' });\n } else {\n next(err);\n }\n});\n```\n\n### Static File Serving\n\n#### Basic Setup\n```javascript\n// Serve files from /public directory\napp.serveStatic('public');\n\n// Files will be available at:\n// /public/images/logo.png -> /images/logo.png\n// /public/css/style.css -> /css/style.css\n\n// The static path prefix (e.g., /public) is stripped from the URL automatically.\n\n// With custom prefix\napp.serveStatic('assets');\n// The static path prefix /assets is stripped from the URL.\n```\n\n### File Uploads\n\n#### Configuration Options\n```javascript\n// Complete configuration\napp.setFileConfig({\n maxSize: 50, // 50MB max file size (in MB, converted to bytes internally)\n allowedTypes: [ // Allowed MIME types\n 'image/jpeg',\n 'image/png',\n 'application/pdf'\n ],\n maxFiles: 5, // Maximum files per upload\n keepOriginalName: false, // Randomize filenames\n});\n\n// Individual settings\napp.setFileSizeLimit(100); // 100MB\napp.setAllowedFileTypes(['image/*']); // All image types\napp.setMaxFiles(10);\napp.setKeepOriginalName(true);\n\n// Wildcard MIME types\napp.setAllowedFileTypes([\n 'image/*', // All images\n 'application/pdf',\n 'text/plain'\n]);\n\n// Custom validation\napp.useMiddleware((req, res, next) => {\n if (req.files) {\n for (const file of Object.values(req.files)) {\n if (file.size > customLimit) {\n return res.status(413).send('Custom size limit exceeded');\n }\n }\n }\n next();\n});\n```\n\n#### Handling Uploads\n```javascript\napp.post('/upload', (req, res) => {\n if (!req.files || Object.keys(req.files).length === 0) {\n return res.status(400).send('No files were uploaded');\n }\n\n const file = req.files.avatar;\n\n res.json({\n originalName: file.name,\n savedName: file.newname,\n size: file.size,\n type: file.type,\n path: file.path\n });\n});\n\n// Multiple files\napp.post('/gallery', (req, res) => {\n const files = req.files.images; // Array when multiple\n\n const results = files.map(file => ({\n name: file.name,\n url: `/uploads/\\${file.newname}`,\n size: file.size\n }));\n\n res.json({ uploaded: results });\n});\n\n// Mixed form data and files\napp.post('/profile', (req, res) => {\n const { username, bio } = req.body;\n const avatar = req.files.avatar;\n\n // Process data\n res.json({\n profile: { username, bio },\n avatarUrl: `/uploads/\\${avatar.newname}`\n });\n});\n```\n\n### Template Engine\n\n#### Enhanced HTML Templates with New Features\n\n**File Includes:**\n```html\n@include('header.html')\n@include('navbar.html', {currentPage: 'products'})\n@include('footer.html', {showCopyright: true})\n```\n\n**Destructuring:**\n```html\n@var {title, description, price} = product;\n@var [mainImage, ...otherImages] = images;\n\n@description
\n$@price\n```\n\n**Function Calls:**\n```html\n@var discountedPrice = calculateDiscount(price, discountPercent);\n@var isAvailable = checkAvailability(productId);\n\n@if(isAvailable)\n \n@end\n```\n\n**Complex Examples:**\n```html\n@var {user: {name, email}, orders: [latestOrder, ...otherOrders]} = data;\n\nTotal friends: @{user.friends.length}
\nThe requested page could not be found.
\n \\${process.env.NODE_ENV === 'development' ? `\nURL: \\${req.url}
\nMethod: \\${req.method}
\n\\${err.message}
\n \\${process.env.NODE_ENV === 'development' ?\n `\\${err.stack}` : ''}\n`);\n\n// Custom business error\napp.on(402, () => `\n Please upgrade your account to access this feature
\n View pricing plans\n`);\n```\n\n#### Error Middleware\n```javascript\n// JSON error responses for API routes\napp.useErrorMiddleware((err, req, res, next) => {\n if (req.path.startsWith('/api')) {\n res.status(err.statusCode || 500).json({\n error: err.message,\n ...(process.env.NODE_ENV === 'development' && { stack: err.stack })\n });\n } else {\n next(err); // Pass to next error handler\n }\n});\n\n// HTML error pages for regular routes\napp.useErrorMiddleware((err, req, res, next) => {\n res.status(err.statusCode || 500);\n\n // Check if accepts HTML\n const acceptsHtml = req.accepts('html');\n const acceptsJson = req.accepts('json');\n\n if (acceptsHtml) {\n // Try custom error handler first\n if (app.customErrors[err.statusCode || 500]) {\n const errorContent = app.customErrors[err.statusCode || 500](err, req, res);\n res.send(errorContent);\n } else {\n // Fallback to default\n res.send(`\n\\${err.message}
\n \\${process.env.NODE_ENV === 'development' ? `\\${err.stack}` : ''}\n `);\n }\n } else if (acceptsJson) {\n res.json({ error: err.message });\n } else {\n res.send(err.message);\n }\n});\n\n// File upload specific errors\napp.useErrorMiddleware((err, req, res, next) => {\n if (err.code === 'LIMIT_FILE_SIZE') {\n res.status(413).json({ error: 'File size exceeds limit' });\n } else if (err.code === 'INVALID_FILE_TYPE') {\n res.status(415).json({ error: 'Invalid file type' });\n } else if (err.code === 'LIMIT_FILE_COUNT') {\n res.status(413).json({ error: 'Too many files' });\n } else {\n next(err);\n }\n});\n```\n\n### Plugin System\n\n#### Creating a Plugin\n```javascript\n// logger.js\nmodule.exports = function(context, options = {}) {\n const { setConfig, addMiddleware, addMethod, getConfig, addRoute } = context;\n const config = {\n level: options.level || 'info',\n format: options.format || 'simple'\n };\n\n // Set plugin configuration\n setConfig('logger', config);\n\n // Add request logging middleware\n addMiddleware((req, res, next) => {\n const start = Date.now();\n res.on('finish', () => {\n const duration = Date.now() - start;\n const message = `\\${req.method} \\${req.url} \\${res.statusCode} \\${duration}ms`;\n log(message, 'info');\n });\n next();\n });\n\n // Add logging method\n addMethod('log', (message, level = 'info') => {\n const levels = ['error', 'warn', 'info', 'debug'];\n const currentLevel = getConfig('logger').level;\n\n if (levels.indexOf(level) <= levels.indexOf(currentLevel)) {\n const timestamp = new Date().toISOString();\n console[level](`[\\${timestamp}] \\${message}`);\n }\n });\n\n // Add debug route if in development\n if (process.env.NODE_ENV === 'development') {\n addRoute('get', '/_logs', (req, res) => {\n res.json({ logs: getLogs() });\n });\n }\n\n return {\n name: 'logger',\n version: '1.0.0',\n description: 'Request logging plugin'\n };\n};\n\n// Usage\napp.usePlugin(require('./logger'), { level: 'debug' });\napp.log('Application started');\n```\n\n#### Using Plugins\n```javascript\n// Authentication plugin\nconst authPlugin = require('./auth-plugin');\napp.usePlugin(authPlugin, {\n secret: process.env.JWT_SECRET,\n routes: ['/api']\n});\n\n\n// Plugin context provides: addMethod, addRoute, addMiddleware, addErrorMiddleware, setConfig, getConfig\n```\n\n### Configuration\n\n#### CORS Configuration\n```javascript\n// Basic CORS\napp.cors({\n origins: ['https://example.com']\n});\n\n// Advanced CORS\napp.cors({\n origins: [\n 'https://example.com',\n 'https://api.example.com',\n 'http://localhost:3000'\n ],\n methods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS', 'PATCH'],\n headers: [\n 'Content-Type',\n 'Authorization',\n 'X-Requested-With',\n 'X-Custom-Header'\n ],\n credentials: true,\n});\n```\n\n#### Security Headers\n```javascript\n// Add security headers middleware\napp.useMiddleware((req, res, next) => {\n res.set({\n 'X-Content-Type-Options': 'nosniff',\n 'X-Frame-Options': 'DENY',\n 'X-XSS-Protection': '1; mode=block',\n 'Strict-Transport-Security': 'max-age=63072000; includeSubDomains; preload',\n 'Content-Security-Policy': `\n default-src 'self';\n script-src 'self' 'unsafe-inline' https://cdn.example.com;\n style-src 'self' 'unsafe-inline';\n img-src 'self' data: https://*.example.com;\n font-src 'self' https://fonts.gstatic.com;\n connect-src 'self' https://api.example.com;\n frame-ancestors 'none';\n `.replace(/\\s+/g, ' '),\n 'Referrer-Policy': 'strict-origin-when-cross-origin',\n 'Permissions-Policy': 'geolocation=(), microphone=()'\n });\n next();\n});\n\n// Rate limiting middleware\napp.useMiddleware((req, res, next) => {\n const ip = req.ip;\n const current = rateLimiter[ip] || 0;\n\n if (current >= 100) {\n return res.status(429).send('Too many requests');\n }\n\n rateLimiter[ip] = current + 1;\n setTimeout(() => {\n rateLimiter[ip] = Math.max(0, (rateLimiter[ip] || 0) - 1);\n }, 60000);\n\n next();\n});\n```\n\n## 🏗️ Architecture\n\nNovaxJS follows these core principles:\n\n1. **Minimalist Core**: Only essential features in the core framework\n2. **Extensible**: Plugin system for adding functionality\n3. **Unopinionated**: Flexible structure for different use cases\n4. **Performance Focused**: Optimized for speed and low memory usage\n5. **Security Conscious**: Safe defaults and validation for all operations\n\n### Core Components\n\n1. **Server Layer**: HTTP server with request/response handling\n2. **Routing System**: Flexible route definitions with middleware support\n3. **Template Engine**: Dual-mode rendering (HTML and JavaScript) with new @ syntax\n4. **File Handling**: Uploads, downloads, and static file serving\n5. **Middleware Pipeline**: Request/response processing chain\n6. **Error Handling**: Customizable error responses and logging\n7. **Plugin API**: Extensibility point for framework features\n8. **Cookie Management**: Built-in cookie parsing and manipulation\n9. **Router Modularization**: Support for external router modules\n\n### Lifecycle of a Request\n\n1. **Incoming Request**: Server receives HTTP request\n2. **Cookie Parsing**: Parse cookies from request headers\n3. **CORS Handling**: Preflight checks if applicable\n4. **Body Parsing**: JSON, form-data, or urlencoded parsing\n5. **Middleware Execution**: Application-level middleware stack\n6. **Route Matching**: Find matching route based on path and method\n7. **Route Middleware**: Route-specific middleware execution\n8. **Route Handler**: Main route logic execution\n9. **Response Generation**: Send response or render template (with minification)\n10. **Error Handling**: If any errors occur in the pipeline\n11. **Final Response**: Send final response to client (with cookies if set)\n\n## 📜 License\n\nISC License\n\n---\n\nThis documentation covers all features and capabilities of NovaxJS v9.4.4, including both existing functionality and new enhancements. For more examples and advanced usage patterns, please refer to the official documentation website.","readmeFilename":"README.md"}