Stateful Auth with MongoDB (Mongoose)

Session-based authentication using MongoDB and Mongoose with server-managed sessions.

Installation Guide

You can add the stateful authentication blueprint to your project using the Servercn CLI:

npx servercn-cli@latest add blueprint stateful-auth

API Endpoints

All endpoints are the same for both MVC and Feature architectures.

Authentication Routes

Base URL: `http://localhost:3000/api/v1/auth`

Method	Endpoint	Description
POST	/verify-otp	Verify OTP for email verification
POST	/signup	Register new user
POST	/signin	Login user
GET	/profile	Get user profile
PATCH	/profile	Update profile (with avatar)
POST	/logout	Logout current user
POST	/forgot-password	Request password reset OTP
POST	/reset-password	Reset password with OTP
POST	/change-password	Change current password
DELETE	/delete-account	Soft delete account
PUT	/reactivate-account	Restore deleted account

Session Management

Base URL: `http://localhost:3000/api/v1/auth/sessions`

Method	Endpoint	Description
GET	/sessions	Get all active user sessions
DELETE	/sessions	Revoke all sessions except current
DELETE	/sessions/:sessionId	Revoke specific session

OAuth Routes

Base URL: `http://localhost:3000/api/auth`

Method	Endpoint	Description
GET	/github	Initiate GitHub OAuth
GET	/github/callback	GitHub OAuth callback
GET	/google	Initiate Google OAuth
GET	/google/callback	Google OAuth callback

Health Check

Base URL: `http://localhost:3000/api/v1/health`

Method	Endpoint	Description
GET	/	Basic health check
GET	/detailed	Detailed health status

Architecture Comparison

MVC Structure

project/
├── src/
│   ├── controllers/
│   │   ├── auth.controller.ts      # All auth endpoints
│   │   ├── health.controller.ts    # Health checks
│   │   └── oauth.controller.ts     # OAuth callbacks
│   ├── models/
│   │   ├── user.model.ts           # User schema + methods
│   │   ├── session.model.ts        # Session schema
│   │   └── otp.model.ts            # OTP schema
│   ├── services/
│   │   ├── auth.service.ts         # Core auth logic
│   │   ├── email.service.ts        # Email sending
│   │   ├── otp.service.ts          # OTP generation/verify
│   │   └── upload.service.ts       # Cloudinary upload
│   ├── routes/
│   │   ├── auth.routes.ts          # /api/auth routes
│   │   ├── oauth.routes.ts         # /api/oauth routes
│   │   ├── health.routes.ts        # /api/health routes
│   │   └── index.ts                # Route aggregator
│   ├── middlewares/
│   │   ├── verify-auth.ts          # JWT/session validation
│   │   ├── validate-request.ts     # Zod validation
│   │   ├── rate-limiter.ts         # Rate limiting rules
│   │   ├── upload-file.ts          # Multer setup
│   │   ├── user-account-restriction.ts  # Account status check
│   │   └── validate-id.ts          # ObjectId validation
│   ├── validators/
│   │   └── auth/
│   │       └── index.ts            # Zod schemas
│   ├── constants/
│   │   └── auth.constants.ts       # Auth constants
│   ├── helpers/
│   │   ├── api-error.ts            # Error helper
│   │   ├── async-handler.ts        # Async wrapper
│   │   └── pick.ts                 # Object picker
│   ├── utils/
│   │   ├── logger.ts               # Winston logger
│   │   ├── response-formatter.ts   # API response wrapper
│   │   ├── error-handler.ts        # Global error handler
│   │   ├── http-status-codes.ts    # HTTP codes
│   │   ├── not-found-handler.ts    # 404 handler
│   │   └── shutdown.ts             # Graceful shutdown
│   ├── types/
│   │   └── express.d.ts            # Express type extensions
│   ├── configs/
│   │   ├── cors.config.ts          # CORS settings
│   │   ├── db.config.ts            # MongoDB connection
│   │   ├── env.config.ts           # Env validation
│   │   ├── passport.config.ts      # Passport strategies
│   │   └── security.config.ts      # Security headers
│   ├── app.ts                      # Express app setup
│   └── server.ts                   # Server entry point
├── swagger.config.ts               # Swagger configuration
└── package.json

Feature Structure

project/
├── src/
│   ├── modules/
│   │   ├── auth/
│   │   │   ├── auth.controller.ts     # Auth endpoints
│   │   │   ├── auth.service.ts        # Auth logic
│   │   │   ├── auth.routes.ts         # Auth routes
│   │   │   ├── auth.types.ts          # TypeScript types
│   │   │   ├── auth.constants.ts      # Auth constants
│   │   │   ├── auth.validation.ts     # Zod schemas
│   │   │   ├── user.model.ts          # User schema
│   │   │   └── session.model.ts       # Session schema
│   │   ├── otp/
│   │   │   ├── otp.service.ts         # OTP generation/verify
│   │   │   └── otp.model.ts           # OTP schema
│   │   ├── oauth/
│   │   │   ├── oauth.controller.ts    # OAuth callbacks
│   │   │   ├── oauth.service.ts       # OAuth logic
│   │   │   └── oauth.routes.ts        # OAuth routes
│   │   ├── upload/
│   │   │   └── upload.service.ts      # Cloudinary upload
│   │   └── health/
│   │       ├── health.controller.ts   # Health endpoints
│   │       └── health.routes.ts       # Health routes
│   ├── routes/
│   │   ├── index.ts                   # Main router
│   │   └── health.routes.ts           # Health routes
│   ├── shared/
│   │   ├── middlewares/
│   │   │   ├── verify-auth.ts         # JWT validation
│   │   │   ├── validate-request.ts    # Zod validation
│   │   │   ├── rate-limiter.ts        # Rate limiting
│   │   │   ├── upload-file.ts         # Multer setup
│   │   │   ├── user-account-restriction.ts  # Account check
│   │   │   └── validate-id.ts         # ObjectId validation
│   │   ├── helpers/
│   │   │   ├── api-error.ts           # Error helper
│   │   │   ├── async-handler.ts       # Async wrapper
│   │   │   └── pick.ts                # Object picker
│   │   ├── utils/
│   │   │   ├── logger.ts              # Winston logger
│   │   │   ├── response-formatter.ts  # Response wrapper
│   │   │   ├── error-handler.ts       # Global error handler
│   │   │   ├── http-status-codes.ts   # HTTP codes
│   │   │   ├── not-found-handler.ts   # 404 handler
│   │   │   └── shutdown.ts            # Graceful shutdown
│   │   └── constants/
│   │       └── api-response.constants.ts  # Response constants
│   ├── types/
│   │   └── express.d.ts               # Express type extensions
│   ├── app.ts                         # Express app setup
│   └── server.ts                      # Server entry point
├── swagger.config.ts                  # Swagger configuration
└── package.json

Key Files

Controllers

auth.controller.ts - Handles signup, signin, profile management, password operations, session management
oauth.controller.ts - GitHub & Google OAuth callback handlers
health.controller.ts - Basic and detailed health checks

Services

auth.service.ts - Core authentication business logic
email.service.ts - Email delivery using Nodemailer
otp.service.ts - OTP generation, hashing, and verification
upload.service.ts - Cloudinary file upload integration

Models

user.model.ts - User schema with hooks and instance methods
session.model.ts - Session tracking schema
otp.model.ts - One-time password schema

Routes

auth.routes.ts - All authentication endpoints
oauth.routes.ts - OAuth flow routes
health.routes.ts - Health check endpoints

Stateful Auth with MongoDB (Mongoose)

File & Folder Structure