express-genix 3.0.0 → 3.0.1

package/README.md

@@ -3,6 +3,7 @@
 A production-grade CLI tool that generates Express.js applications with best-in-class defaults. Scaffold a complete REST API in seconds — with TypeScript, authentication, Prisma/Mongoose/Sequelize, Docker, CI/CD, and more.
 
 [![npm version](https://img.shields.io/npm/v/express-genix.svg)](https://www.npmjs.com/package/express-genix)
+[![npm downloads](https://img.shields.io/npm/dm/express-genix.svg)](https://www.npmjs.com/package/express-genix)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg)](https://nodejs.org)
 
@@ -115,19 +116,22 @@ express-genix add prisma      # Adds Prisma schema, client config, migrations
 ```
 my-express-app/
 ├── src/
-│   ├── config/          # Database, Swagger, WebSocket configuration
-│   ├── controllers/     # Route handlers
-│   ├── middleware/       # Auth, validation, error handling, request ID
-│   ├── models/          # Database models (Mongoose/Sequelize)
+│   ├── config/          # Database, Swagger, WebSocket, queue configuration
+│   ├── controllers/     # Route handlers (auth, user, admin, example)
+│   ├── graphql/         # GraphQL type definitions & resolvers (if selected)
+│   ├── jobs/            # BullMQ background workers (if selected)
+│   ├── middleware/      # Auth, RBAC, validation, error handling, uploads, metrics, audit log
+│   ├── models/          # Database models (Mongoose/Sequelize/Prisma)
 │   ├── routes/          # API route definitions with Swagger annotations
-│   ├── services/        # Business logic layer
+│   ├── services/        # Business logic layer (auth, user, email)
 │   ├── utils/           # Logger, errors, response helpers, validators
 │   ├── app.js|ts        # Express app setup
-│   └── server.js|ts     # Server + clustering + WebSocket
+│   └── server.js|ts     # Server + clustering + WebSocket + workers
 ├── tests/               # Jest + Supertest suites
 ├── prisma/              # Prisma schema (if selected)
 ├── migrations/          # Sequelize migrations (if PostgreSQL + Sequelize)
 ├── seeders/             # Sequelize seeders (if PostgreSQL + Sequelize)
+├── uploads/             # File upload directory (if selected)
 ├── .github/workflows/   # CI/CD pipeline (if selected)
 ├── .env                 # Auto-generated environment config
 ├── .env.example         # Template for team sharing
@@ -138,6 +142,8 @@ my-express-app/
 
 ## API Endpoints (with database + auth)
 
+> When API versioning is enabled, all `/api/*` routes become `/api/v1/*`.
+
 ### Authentication
 | Method | Endpoint | Description |
 |--------|----------|-------------|
@@ -153,12 +159,35 @@ my-express-app/
 |--------|----------|-------------|
 | GET | `/api/users/profile` | Get current user |
 | PUT | `/api/users/profile` | Update profile |
-| DELETE | `/api/users/profile` | Delete account |
+| DELETE | `/api/users/profile` | Delete account (soft delete if enabled) |
+
+### Admin (RBAC — admin role required)
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/api/admin/users` | List all users (paginated) |
+| GET | `/api/admin/users/:id` | Get user by ID |
+| PUT | `/api/admin/users/:id/role` | Update user role |
+| DELETE | `/api/admin/users/:id` | Delete user |
+| POST | `/api/admin/users/:id/restore` | Restore soft-deleted user |
 
-### Health
+### File Uploads
 | Method | Endpoint | Description |
 |--------|----------|-------------|
-| GET | `/health` | Health check with uptime, DB status, Redis status, memory usage |
+| POST | `/api/uploads/single` | Upload a single file |
+| POST | `/api/uploads/multiple` | Upload multiple files (max 10) |
+
+### Background Jobs (BullMQ)
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| POST | `/api/jobs` | Dispatch a background job |
+| GET | `/api/jobs/:id` | Get job status |
+
+### Observability & Health
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/health` | Health check (uptime, DB, Redis, memory) |
+| GET | `/metrics` | Prometheus metrics (prom-client) |
+| GET | `/graphql` | GraphQL Playground (Apollo Server) |
 
 ## Available Scripts
 
@@ -197,10 +226,17 @@ Generated `.env` includes auto-generated JWT secrets:
 | `JWT_SECRET` | Access token secret (auto-generated) | — |
 | `JWT_REFRESH_SECRET` | Refresh token secret (auto-generated) | — |
 | `MONGO_URI` / `DATABASE_URL` | Database connection string | — |
-| `REDIS_URL` | Redis URL (when Redis blacklist enabled) | `redis://localhost:6379` |
+| `REDIS_URL` | Redis URL (token blacklist, caching, BullMQ) | `redis://localhost:6379` |
 | `RATE_LIMIT_WINDOW_MS` | Rate limit window (ms) | `900000` |
 | `RATE_LIMIT_MAX` | Max requests per window | `100` |
 | `LOG_LEVEL` | Logging level | `info` |
+| `SMTP_HOST` | SMTP server host (email service) | — |
+| `SMTP_PORT` | SMTP server port | `587` |
+| `SMTP_USER` | SMTP username | — |
+| `SMTP_PASS` | SMTP password | — |
+| `EMAIL_FROM` | Default sender address | — |
+| `UPLOAD_MAX_SIZE` | Max file upload size in bytes | `5242880` (5 MB) |
+| `UPLOAD_DIR` | Upload destination directory | `uploads` |
 
 ## Docker
 
@@ -208,6 +244,8 @@ Generated `.env` includes auto-generated JWT secrets:
 docker-compose up --build
 ```
 
+The generated `docker-compose.yml` includes services for your app and its dependencies (MongoDB/PostgreSQL, Redis) with health checks, volumes, and a shared network. The `Dockerfile` uses multi-stage builds, runs as a non-root user, and only copies production dependencies.
+
 ## Contributing
 
 Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "express-genix",
-    "version": "3.0.0",
+    "version": "3.0.1",
     "description": "Production-grade CLI to generate Express apps with JWT, RBAC, GraphQL, TypeScript, Prisma, MongoDB, PostgreSQL, file uploads, email, background jobs, and more",
     "main": "index.js",
     "bin": {