express-genix 1.1.4 → 2.0.0

package/templates/core/Dockerfile.ejs

@@ -1,32 +1,42 @@
-# templates/core/Dockerfile.ejs
-FROM node:20-alpine
-
-# Set working directory
-WORKDIR /app
-
-# Copy package files
-COPY package*.json ./
-
-# Install dependencies
-RUN npm ci --only=production && npm cache clean --force
-
-# Copy application code
-COPY . .
-
-# Create non-root user
-RUN addgroup -g 1001 -S nodejs
-RUN adduser -S nodeuser -u 1001
-
-# Change ownership of app directory
-RUN chown -R nodeuser:nodejs /app
-USER nodeuser
-
-# Expose port
-EXPOSE 3000
-
-# Health check
-HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
-  CMD node healthcheck.js
-
-# Start application
+FROM node:20-alpine
+
+# Set working directory
+WORKDIR /app
+
+# Copy package files
+COPY package*.json ./
+<% if (isPrisma) { %>
+# Copy Prisma schema for generation
+COPY prisma ./prisma/
+<% } %>
+# Install dependencies
+RUN npm ci --only=production && npm cache clean --force
+<% if (isPrisma) { %>
+# Generate Prisma client
+RUN npx prisma generate
+<% } %><% if (isTypescript) { %>
+# Copy source and build
+COPY tsconfig.json ./
+COPY src ./src/
+RUN npx tsc
+<% } else { %>
+# Copy application code
+COPY . .
+<% } %>
+# Create non-root user
+RUN addgroup -g 1001 -S nodejs
+RUN adduser -S nodeuser -u 1001
+
+# Change ownership of app directory
+RUN chown -R nodeuser:nodejs /app
+USER nodeuser
+
+# Expose port
+EXPOSE 3000
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
+  CMD node healthcheck.js
+
+# Start application
 CMD ["npm", "start"]

package/templates/core/README.md.ejs

@@ -1,179 +1,191 @@
-# <%= projectName %>
-
-A production-grade Express.js boilerplate<% if (hasDatabase) { %> with JWT authentication, <%= db %> support<% } %>, rate-limiting, security middleware, logging, API documentation, testing, and more.
-
-## Features
-
-<% if (hasDatabase) { %>- **Authentication**: JWT-based authentication with refresh tokens
-- **Database**: <%= db === 'mongodb' ? 'MongoDB with Mongoose' : 'PostgreSQL with Sequelize' %>
-- **User Management**: Complete user registration, login, profile management<% } else { %>- **No Database**: Perfect for microservices, proxy servers, or computational APIs
-- **Example API**: CRUD operations with in-memory storage (easily replaceable)<% } %>
-- **Security**: Helmet, CORS, rate limiting
-- **Logging**: Morgan HTTP request logger with custom logging utilities
-- **API Documentation**: Swagger UI
-- **Testing**: Jest and Supertest
-- **Code Quality**: ESLint with Airbnb configuration, Prettier formatting
-- **Deployment**: Docker support with clustering
-- **Project Structure**: Clean, modular Express.js architecture
-
-## Project Structure
-
-```
-├── src/
-│   ├── config/             # Configuration files (swagger<% if (hasDatabase) { %>, database<% } %>)
-│   ├── controllers/        # Request handlers and business logic orchestration<% if (hasDatabase) { %>
-│   ├── middleware/         # Custom middleware (auth, validation, errors)<% } else { %>
-│   ├── middleware/         # Custom middleware (errors)<% } %>
-<% if (hasDatabase) { %>│   ├── models/             # Database models<% } %>
-│   ├── routes/             # API endpoint definitions
-│   ├── services/           # Business logic layer
-│   ├── utils/              # Utility functions and helpers
-│   ├── app.js              # Express app configuration
-│   └── server.js           # Server setup and clustering
-├── tests/                  # Test files
-├── .env                    # Environment variables
-├── .gitignore              # Git ignore rules
-├── package.json            # Dependencies and scripts
-└── README.md               # Project documentation
-```
-
-## Setup
-
-1. **Install Dependencies**
-   ```bash
-   npm install
-   ```
-
-2. **Environment Configuration**
-   - Copy `.env` and configure your environment variables<% if (hasDatabase) { %>
-   - Update database connection settings
-   - Change JWT secrets for production<% } %>
-
-<% if (hasDatabase) { %>3. **Database Setup**<% if (db === 'mongodb') { %>
-   - Ensure MongoDB is running locally or update MONGO_URI
-   - Database will be created automatically<% } else if (db === 'postgresql') { %>
-   - Ensure PostgreSQL is running locally
-   - Create a database matching your DATABASE_URL
-   - Run migrations if needed<% } %>
-
-4.<% } else { %>3.<% } %> **Start Development Server**
-   ```bash
-   npm run dev
-   ```
-
-<% if (hasDatabase) { %>5.<% } else { %>4.<% } %> **Production**
-   ```bash
-   npm start
-   ```
-
-## Available Scripts
-
-- `npm run dev` - Start development server with nodemon
-- `npm start` - Start production server with clustering
-- `npm test` - Run tests with coverage
-- `npm run lint` - Run ESLint
-- `npm run lint:fix` - Fix ESLint issues automatically
-- `npm run format` - Format code with Prettier
-- `npm run format:check` - Check code formatting
-
-## API Documentation
-
-Visit `http://localhost:3000/api-docs` for interactive Swagger documentation.
-
-## API Endpoints
-
-<% if (hasDatabase) { %>### Authentication
-- `POST /api/auth/register` - Register new user
-- `POST /api/auth/login` - User login
-- `POST /api/auth/refresh` - Refresh access token
-- `POST /api/auth/logout` - User logout
-
-### Users
-- `GET /api/users/profile` - Get user profile (protected)
-- `PUT /api/users/profile` - Update user profile (protected)
-- `DELETE /api/users/profile` - Delete user profile (protected)<% } else { %>### Examples
-- `GET /api/examples` - Get all examples (with pagination)
-- `GET /api/examples/:id` - Get example by ID
-- `POST /api/examples` - Create new example
-- `PUT /api/examples/:id` - Update example
-- `DELETE /api/examples/:id` - Delete example<% } %>
-
-### Health Check
-- `GET /health` - Application health status
-
-## Environment Variables
-
-| Variable | Description | Default |
-|----------|-------------|---------|
-| NODE_ENV | Environment mode | development |
-| PORT | Server port | 3000 |<% if (hasDatabase) { %>
-| JWT_SECRET | JWT signing secret | - |
-| JWT_REFRESH_SECRET | Refresh token secret | - |
-| JWT_EXPIRE | Access token expiry | 15m |
-| JWT_REFRESH_EXPIRE | Refresh token expiry | 7d |
-| <%= db === 'mongodb' ? 'MONGO_URI' : 'DATABASE_URL' %> | Database connection | - |<% } %>
-| RATE_LIMIT_WINDOW_MS | Rate limit window | 900000 |
-| RATE_LIMIT_MAX | Max requests per window | 100 |
-
-## Testing
-
-```bash
-# Run all tests
-npm test
-
-# Run tests with coverage
-npm run test
-
-# Run tests in watch mode
-npm run test:watch
-```
-
-## Deployment
-
-### Docker
-
-1. **Build Image**
-   ```bash
-   docker build -t <%= projectName %> .
-   ```
-
-2. **Run Container**
-   ```bash
-   docker run -p 3000:3000 --env-file .env <%= projectName %>
-   ```
-
-3. **Docker Compose**
-   ```bash
-   docker-compose up
-   ```
-
-## Security Features
-
-- **Helmet**: Sets various HTTP headers for security
-- **CORS**: Configurable cross-origin resource sharing
-- **Rate Limiting**: Prevents abuse and DDoS attacks<% if (hasDatabase) { %>
-- **JWT**: Stateless authentication with refresh tokens
-- **Password Hashing**: bcrypt for secure password storage
-- **Input Validation**: Request validation middleware<% } %>
-
-<% if (!hasDatabase) { %>## Extending the Application
-
-This boilerplate is designed for APIs that don't require database persistence. You can easily:
-
-- Add database support by integrating MongoDB or PostgreSQL
-- Replace in-memory storage with external services (Redis, etc.)
-- Add authentication by integrating with OAuth providers
-- Build microservices by adding service-to-service communication
-
-<% } %>## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Add tests for new functionality
-5. Ensure all tests pass
-6. Submit a pull request
-
-## License
-
-MIT License - see LICENSE file for details
+# <%= projectName %>
+
+A production-grade Express.js application generated by [express-genix](https://www.npmjs.com/package/express-genix).
+
+## Features
+
+<% if (isTypescript) { %>- **TypeScript**: Full type safety with TypeScript
+<% } %><% if (hasAuth) { %>- **Authentication**: JWT-based auth with access & refresh tokens, token blacklist logout
+- **User Management**: Registration, login, profile CRUD
+<% } %><% if (hasDatabase) { %>- **Database**: <%= db === 'mongodb' ? 'MongoDB with Mongoose' : (isPrisma ? 'PostgreSQL with Prisma ORM' : 'PostgreSQL with Sequelize') %>
+<% } else { %>- **No Database**: Lightweight API with in-memory storage (easily replaceable)
+<% } %><% if (hasRateLimit) { %>- **Rate Limiting**: Configurable request throttling
+<% } %><% if (hasSwagger) { %>- **API Documentation**: Swagger UI with swagger-jsdoc annotations
+<% } %><% if (hasRequestId) { %>- **Request ID**: Correlation ID tracking per request
+<% } %>- **Security**: Helmet, CORS, input sanitization
+- **Logging**: <%= logger === 'pino' ? 'Pino (fast, structured)' : 'Winston (feature-rich)' %> with Morgan HTTP logger
+- **Testing**: Jest + Supertest with coverage
+- **Code Quality**: ESLint (Airbnb) + Prettier
+<% if (hasDocker) { %>- **Docker**: Multi-stage Dockerfile + docker-compose
+<% } %><% if (hasCicd) { %>- **CI/CD**: GitHub Actions workflow
+<% } %>- **Production**: Clustering, graceful shutdown, environment validation
+
+## Project Structure
+
+```
+<%= projectName %>/
+├── src/
+│   ├── config/             # Database, Swagger configuration
+│   ├── controllers/        # Route handlers
+│   ├── middleware/          # Auth, validation, error handling<% if (hasDatabase && !isPrisma) { %>
+│   ├── models/             # Database models<% } %>
+│   ├── routes/             # API route definitions
+│   ├── services/           # Business logic
+│   ├── utils/              # Helpers (logger, errors, response, validators)
+│   ├── app.<%= isTypescript ? 'ts' : 'js' %>             # Express app setup
+│   └── server.<%= isTypescript ? 'ts' : 'js' %>          # Server + clustering
+├── tests/                  # Test suites<% if (isPrisma) { %>
+├── prisma/
+│   └── schema.prisma       # Prisma schema<% } %><% if (hasCicd) { %>
+├── .github/workflows/      # CI/CD pipeline<% } %>
+├── .env                    # Environment variables (do not commit)
+├── .env.example            # Environment template
+└── package.json
+```
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js >= 18
+- npm >= 9<% if (db === 'mongodb') { %>
+- MongoDB (local or cloud)<% } else if (hasDatabase) { %>
+- PostgreSQL 15+<% } %>
+
+### Installation
+
+```bash
+npm install
+```
+<% if (isPrisma) { %>
+### Database Setup
+
+```bash
+# Generate Prisma client
+npx prisma generate
+
+# Run migrations
+npx prisma migrate dev --name init
+
+# Open Prisma Studio (optional)
+npx prisma studio
+```
+<% } else if (db === 'mongodb') { %>
+### Database Setup
+
+Ensure MongoDB is running locally or update `MONGO_URI` in `.env`.
+<% } else if (db === 'postgresql') { %>
+### Database Setup
+
+Create a PostgreSQL database and update `DATABASE_URL` in `.env`. The schema syncs automatically in development.
+<% } %>
+### Environment
+
+Copy `.env.example` to `.env` and update values for your environment:
+
+```bash
+cp .env.example .env
+```
+<% if (hasAuth) { %>
+> **Important**: Change `JWT_SECRET` and `JWT_REFRESH_SECRET` before deploying.
+<% } %>
+### Development
+
+```bash
+npm run dev
+```
+
+### Production
+
+```bash
+npm start
+```
+
+## Available Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run dev` | Development server with auto-reload |
+| `npm start` | Production server with clustering |
+| `npm test` | Run tests with coverage |
+| `npm run lint` | Check for linting errors |
+| `npm run lint:fix` | Auto-fix linting errors |
+| `npm run format` | Format code with Prettier |
+| `npm run format:check` | Check formatting |<% if (isTypescript) { %>
+| `npm run build` | Compile TypeScript |<% } %><% if (isPrisma) { %>
+| `npx prisma studio` | Open Prisma Studio |
+| `npx prisma migrate dev` | Run database migrations |<% } %>
+<% if (hasSwagger) { %>
+## API Documentation
+
+Interactive docs available at [http://localhost:3000/api-docs](http://localhost:3000/api-docs)
+<% } %>
+## API Endpoints
+
+<% if (hasAuth) { %>### Authentication
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| POST | `/api/auth/register` | Register a new user |
+| POST | `/api/auth/login` | Login and receive tokens |
+| POST | `/api/auth/refresh` | Refresh access token |
+| POST | `/api/auth/logout` | Logout (blacklist token) |
+
+### Users (protected)
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/api/users/profile` | Get current user profile |
+| PUT | `/api/users/profile` | Update profile |
+| DELETE | `/api/users/profile` | Delete account |
+<% } else { %>### Examples
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/api/examples` | List all (paginated) |
+| GET | `/api/examples/:id` | Get by ID |
+| POST | `/api/examples` | Create |
+| PUT | `/api/examples/:id` | Update |
+| DELETE | `/api/examples/:id` | Delete |
+<% } %>
+### Health
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/health` | Health check |
+
+## Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `NODE_ENV` | Environment | `development` |
+| `PORT` | Server port | `3000` |<% if (hasAuth) { %>
+| `JWT_SECRET` | Access token secret | *(required)* |
+| `JWT_REFRESH_SECRET` | Refresh token secret | *(required)* |
+| `JWT_EXPIRE` | Access token TTL | `15m` |
+| `JWT_REFRESH_EXPIRE` | Refresh token TTL | `7d` |<% } %><% if (db === 'mongodb') { %>
+| `MONGO_URI` | MongoDB connection string | *(required)* |<% } else if (hasDatabase) { %>
+| `DATABASE_URL` | PostgreSQL connection string | *(required)* |<% } %><% if (hasRateLimit) { %>
+| `RATE_LIMIT_WINDOW_MS` | Rate limit window (ms) | `900000` |
+| `RATE_LIMIT_MAX` | Max requests per window | `100` |<% } %>
+<% if (hasDocker) { %>
+## Docker
+
+```bash
+# Build and run with docker-compose
+docker-compose up --build
+
+# Or build manually
+docker build -t <%= projectName %> .
+docker run -p 3000:3000 --env-file .env <%= projectName %>
+```
+<% } %>
+## Testing
+
+```bash
+npm test
+```
+
+## License
+
+MIT

package/templates/core/app.js.ejs

@@ -1,65 +1,115 @@
-const express = require('express');
-const cors = require('cors');
-const helmet = require('helmet');
-const morgan = require('morgan');
-const rateLimit = require('express-rate-limit');
-const swaggerUi = require('swagger-ui-express');
-const dotenv = require('dotenv');
-
-const routes = require('./routes');
-const errorHandler = require('./middleware/errorHandler');
-const swaggerConfig = require('./config/swagger.json');
-
-// Load environment variables
-dotenv.config();
-
-const app = express();
-
-// Security middleware
-app.use(helmet());
-app.use(cors());
-
-// Logging
-app.use(morgan('dev'));
-
-// Body parsing middleware
-app.use(express.json({ limit: '10mb' }));
-app.use(express.urlencoded({ extended: true }));
-
-// Rate limiting
-const limiter = rateLimit({
-  windowMs: 15 * 60 * 1000, // 15 minutes
-  max: 100, // Limit each IP to 100 requests per windowMs
-  message: 'Too many requests from this IP, please try again later.',
-});
-app.use(limiter);
-
-// Health check endpoint
-app.get('/health', (req, res) => {
-  res.status(200).json({
-    status: 'OK',
-    timestamp: new Date().toISOString(),
-    uptime: process.uptime(),<% if (hasDatabase) { %>
-    database: '<%= db %>'<% } else { %>
-    database: 'none'<% } %>,
-  });
-});
-
-// API documentation
-app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerConfig));
-
-// API routes
-app.use('/api', routes);
-
-// 404 handler
-app.use('*', (req, res) => {
-  res.status(404).json({
-    error: 'Route not found',
-    path: req.originalUrl,
-  });
-});
-
-// Error handling middleware (should be last)
-app.use(errorHandler);
-
+const express = require('express');
+const cors = require('cors');
+const helmet = require('helmet');
+const morgan = require('morgan');
+<% if (hasRateLimit) { %>const rateLimit = require('express-rate-limit');<% } %>
+<% if (hasSwagger) { %>const swaggerUi = require('swagger-ui-express');
+const swaggerSpec = require('./config/swagger');<% } %>
+<% if (hasRequestId) { %>const { requestId } = require('./middleware/requestId');<% } %>
+const routes = require('./routes');
+const errorHandler = require('./middleware/errorHandler');
+<% if (hasDatabase || hasAuth) { %>const { validateEnv } = require('./utils/envValidator');
+
+validateEnv();<% } %>
+
+const app = express();
+
+// Security middleware
+app.use(helmet());
+app.use(cors({
+  origin: process.env.CORS_ORIGIN || '*',
+  methods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],
+  allowedHeaders: ['Content-Type', 'Authorization'],
+}));
+<% if (hasRequestId) { %>
+// Request ID tracking
+app.use(requestId);<% } %>
+
+// Logging
+app.use(morgan(process.env.NODE_ENV === 'production' ? 'combined' : 'dev'));
+
+// Body parsing
+app.use(express.json({ limit: '10mb' }));
+app.use(express.urlencoded({ extended: true }));
+<% if (hasRateLimit) { %>
+// Rate limiting
+const limiter = rateLimit({
+  windowMs: parseInt(process.env.RATE_LIMIT_WINDOW_MS, 10) || 15 * 60 * 1000,
+  max: parseInt(process.env.RATE_LIMIT_MAX, 10) || 100,
+  standardHeaders: true,
+  legacyHeaders: false,
+  message: { success: false, error: 'Too many requests, please try again later.' },
+});
+app.use(limiter);<% } %>
+
+// Health check
+app.get('/health', async (req, res) => {
+  const health = {
+    status: 'OK',
+    timestamp: new Date().toISOString(),
+    uptime: process.uptime(),
+    memoryUsage: Math.round(process.memoryUsage().rss / 1024 / 1024) + ' MB',
+  };
+
+  const checks = {};
+<% if (db === 'mongodb') { %>
+  try {
+    const mongoose = require('mongoose');
+    checks.database = mongoose.connection.readyState === 1 ? 'connected' : 'disconnected';
+  } catch {
+    checks.database = 'error';
+  }
+<% } else if (db === 'postgresql') { %>
+  try {
+    const { sequelize } = require('./models');
+    await sequelize.authenticate();
+    checks.database = 'connected';
+  } catch {
+    checks.database = 'disconnected';
+  }
+<% } else if (isPrisma) { %>
+  try {
+    const { prisma } = require('./config/database');
+    await prisma.$queryRaw\`SELECT 1\`;
+    checks.database = 'connected';
+  } catch {
+    checks.database = 'disconnected';
+  }
+<% } %><% if (hasRedis) { %>
+  try {
+    const { redis } = require('./config/redis');
+    await redis.ping();
+    checks.redis = 'connected';
+  } catch {
+    checks.redis = 'disconnected';
+  }
+<% } %>
+  const allHealthy = Object.values(checks).every((v) => v === 'connected');
+  const statusCode = Object.keys(checks).length === 0 || allHealthy ? 200 : 503;
+  health.status = statusCode === 200 ? 'OK' : 'DEGRADED';
+  health.checks = checks;
+
+  res.status(statusCode).json({ success: statusCode === 200, data: health });
+});
+<% if (hasSwagger) { %>
+// API documentation
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec, {
+  customCss: '.swagger-ui .topbar { display: none }',
+}));<% } %>
+
+// API routes
+app.use('/api', routes);
+
+// 404 handler
+app.use('*', (req, res) => {
+  res.status(404).json({
+    success: false,
+    error: 'Route not found',
+    path: req.originalUrl,
+  });
+});
+
+// Error handler (must be last)
+app.use(errorHandler);
+
 module.exports = app;