nodejs-quickstart-structure 2.0.0 → 2.1.0

package/templates/clean-architecture/ts/src/usecases/getUserById.ts.ejs

@@ -0,0 +1,23 @@
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+<%_ if (caching !== 'None') { _%>
+import cacheService from '<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>';
+<%_ } _%>
+
+export default class GetUserById {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute(id: string | number) {
+        <%_ if (caching !== 'None') { -%>
+        const cacheKey = `user:${id}`;
+        const cachedUser = await cacheService.get(cacheKey);
+        if (cachedUser) return cachedUser;
+        <%_ } -%>
+        const user = await this.userRepository.findById(id);
+        <%_ if (caching !== 'None') { -%>
+        if (user) {
+            await cacheService.set(`user:${id}`, user, 3600); // Cache for 1 hour
+        }<%_ } -%>
+
+        return user;
+    }
+}

package/templates/clean-architecture/ts/src/usecases/updateUser.spec.ts.ejs

@@ -36,6 +36,7 @@ describe('UpdateUser UseCase', () => {
         expect(result).toEqual(expectedUser);
 <%_ if (caching !== 'None') { -%>
         expect(cacheService.del).toHaveBeenCalledWith('users:all');
+        expect(cacheService.del).toHaveBeenCalledWith(`user:${id}`);
 <%_ } %>
     });
 

package/templates/clean-architecture/ts/src/usecases/updateUser.ts.ejs

@@ -0,0 +1,25 @@
+import { User } from '@/domain/user';
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+<%_ if (caching !== 'None') { _%>
+import cacheService from '<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>';
+import logger from '@/infrastructure/log/logger';
+<%_ } _%>
+
+export default class UpdateUser {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute(id: number | string, data: Partial<User>) {
+        const user = await this.userRepository.update(id, data);
+        <%_ if (caching !== 'None') { -%>
+        if (user) {
+            try {
+                await cacheService.del('users:all');
+                await cacheService.del(`user:${id}`);
+            } catch (error) {
+                logger.warn('Failed to clear cache after user update:', error);
+            }
+        }<%_ } -%>
+        
+        return user;
+    }
+}

package/templates/clean-architecture/ts/src/utils/errorMessages.ts

@@ -5,6 +5,7 @@ export const ERROR_MESSAGES = {
     INTERNAL_SERVER_ERROR: 'Internal Server Error',
     BAD_REQUEST: 'Bad Request',
     FETCH_USERS_ERROR: 'Error fetching users',
+    FETCH_USER_ERROR: 'Error fetching user',
     CREATE_USER_ERROR: 'Error creating user',
     UPDATE_USER_ERROR: 'Error updating user',
     DELETE_USER_ERROR: 'Error deleting user',

package/templates/clean-architecture/ts/src/utils/httpCodes.ts

@@ -2,6 +2,7 @@ export const HTTP_STATUS = {
     OK: 200,
     CREATED: 201,
     BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
     NOT_FOUND: 404,
     INTERNAL_SERVER_ERROR: 500
 } as const;

package/templates/common/.cursorrules.ejs

@@ -58,3 +58,12 @@ When indexing or searching the workspace, ignore the following paths to prevent
   - `controllers`: Request handlers and business logic.
   - `routes`: Define endpoints routing to controllers.
 <% } -%>
+
+### 5. Security & Authentication
+<% if (auth.includes('JWT')) { -%>
+- **Protected Routes**: When adding new routes, consider if they need `authMiddleware`.
+- **User Identity**: Extract user info from `req.user` (populated by middleware).
+- **Sensitive Data**: Never return passwords in API responses (ensure `.toJSON()` or DTOs handle this).
+<% } -%>
+- **Input Validation**: Always validate user input using schemas or controller-level checks.
+- **Sanitization**: Ensure inputs are sanitized before being used in DB queries (though our ORMs like Sequelize/Mongoose handle much of this).

package/templates/common/.env.example.ejs

@@ -1,8 +1,8 @@
 # Application
 PORT=3000
 NODE_ENV=development
-
 <%_ if (database !== 'None') { -%>
+
 # Database
 <%_ if (database === 'MySQL') { -%>
 DB_HOST=localhost
@@ -10,32 +10,39 @@ DB_PORT=3306
 DB_USER=root
 DB_PASSWORD=root
 DB_NAME=<%= dbName %>
-<%_ } -%>
+<% } -%>
 <%_ if (database === 'PostgreSQL') { -%>
 DB_HOST=localhost
 DB_PORT=5432
 DB_USER=postgres
 DB_PASSWORD=root
 DB_NAME=<%= dbName %>
-<%_ } -%>
+<% } -%>
 <%_ if (database === 'MongoDB') { -%>
 DB_HOST=localhost
 DB_PORT=27017
 DB_NAME=<%= dbName %>
-<%_ } -%>
-<%_ } -%>
-
-
+<% } -%>
+<% } -%>
 <%_ if (communication === 'Kafka') { -%>
+
 # Communication
 KAFKA_BROKER=localhost:9093
 KAFKA_CLIENT_ID=<%= projectName %>
 KAFKA_GROUP_ID=<%= projectName %>-group
-<%_ } -%>
-
+<% } -%>
 <%_ if (caching === 'Redis') { -%>
+
 # Caching
 REDIS_HOST=localhost
 REDIS_PORT=6379
 REDIS_PASSWORD=
-<%_ } -%>
+<% } -%>
+<%_ if (auth.includes('JWT')) { -%>
+
+# Authentication
+JWT_SECRET=your_jwt_secret_key_here_change_it
+JWT_REFRESH_SECRET=your_jwt_refresh_secret_key_here_change_it
+JWT_EXPIRES_IN=15m
+JWT_REFRESH_EXPIRES_IN=7d
+<% } -%>

package/templates/common/.gitlab-ci.yml.ejs

@@ -1,5 +1,7 @@
 variables:
   NODE_ENV: 'test'
+  WAIT_ON_HOST: docker
+  TEST_URL: http://docker:3001
 
 stages:
   - lint
@@ -30,7 +32,7 @@ run_unit_tests:
   stage: test
   image: node:22-slim
   script:
-    - npm run test:coverage
+    - npm run test:coverage -- --maxWorkers=2
 
 run_e2e_tests:
   stage: test

package/templates/common/Jenkinsfile.ejs

@@ -3,6 +3,15 @@ pipeline {
 
     environment {
         CI = 'true'
+        DOCKER_BUILDKIT = '0'
+        PORT = '3001'
+        DB_PORT = '3307'
+        WAIT_ON_HOST = 'host.docker.internal'
+        TEST_URL = 'http://host.docker.internal:3001'
+    }
+
+    tools {
+        nodejs 'nodejs'
     }
 
     stages {
@@ -21,7 +30,7 @@ pipeline {
 
         stage('Unit Test') {
             steps {
-                sh 'npm run test:coverage'
+                sh 'npm run test:coverage -- --maxWorkers=2'
             }
         }
 

package/templates/common/README.md.ejs

@@ -29,9 +29,10 @@ This project follows a strict **7-Step Production-Ready Process** to ensure qual
 
 -   **Architecture**: <%= architecture %> (<% if (architecture === 'Clean Architecture') { %>Domain, UseCases, Infrastructure<% } else { %>MVC Pattern<% } %>).
 -   **Database**: <%= database %> <% if (database !== 'None') { %>(via <%= database === 'MongoDB' ? 'Mongoose' : 'Sequelize' %>)<% } %>.
+<% if (auth.includes('JWT')) { %>-   **Authentication**: JWT-based Auth (Sign Up, Login, Protected Routes).<% } %>
 -   **Security**: Helmet, CORS, Rate Limiting, HPP, Snyk SCA.
 -   **Quality**: 80%+ Test Coverage, Eslint, Prettier, Husky.
--   **DevOps**: Multi-stage Docker, CI/CD ready (GitHub/GitLab/Jenkins).
+-   **DevOps**: Multi-stage Docker, CI/CD ready (GitHub/GitLab/Jenkins/Bitbucket/CircleCI).
 <% if (includeSecurity) { %>-   **Enterprise Hardening**: SonarCloud SAST, Security Policies.<% } %>
 
 ## 📂 Project Structure
@@ -95,6 +96,21 @@ Microservices communication handled via **Kafka**.
 API is exposed via **GraphQL**.
 The Apollo Sandbox UI for API exploration and documentation is available natively, fully embedded for offline development:
 - **URL**: `http://localhost:3000/graphql` (Dynamic based on PORT)
+
+<%_ if (auth.includes('JWT')) { _%>
+### 🔐 Authorization
+To access protected resolvers (Query: `getAllUsers`, Mutations: `updateUser`, `deleteUser`), you must provide a valid JWT token in the headers.
+
+**How to authenticate:**
+1. Use the REST login endpoint: `POST /api/auth/login` (with your email and password).
+2. Copy the `accessToken` from the response.
+3. In the Apollo Sandbox "HTTP Headers" tab (bottom section), add:
+```json
+{
+  "Authorization": "Bearer YOUR_ACCESS_TOKEN_HERE"
+}
+```<%_ } _%>
+
 If you are opening `http://localhost:3000/graphql` in your browser, you can directly run the following in the Apollo Sandbox UI:
 
 **Query to get all users:**
@@ -111,7 +127,7 @@ query GetAllUsers {
 **Mutation to create a user:**
 ```graphql
 mutation CreateUser {
-  createUser(name: "John Doe", email: "john@example.com") {
+  createUser(name: "John Doe", email: "john@example.com"<%_ if (auth.includes('JWT')) { _%>, password: "yourpassword123"<%_ } _%>) {
     id
     name
     email
@@ -119,7 +135,7 @@ mutation CreateUser {
 }
 ```
 
-**Mutation to update a user:**
+**Mutation to update a user (Protected):**
 ```graphql
 mutation UpdateUser {
   updateUser(id: "1", name: "John Updated") {
@@ -130,7 +146,7 @@ mutation UpdateUser {
 }
 ```
 
-**Mutation to delete a user:**
+**Mutation to delete a user (Protected):**
 ```graphql
 mutation DeleteUser {
   deleteUser(id: "1")
@@ -143,32 +159,61 @@ A Swagger UI for API documentation is available at:
 
 ### 🛣️ User Endpoints:
 - `GET /api/users`: List all users.
+- `GET /api/users/:id`: Get a user by ID.
 - `POST /api/users`: Create a new user.
 - `PATCH /api/users/:id`: Partially update a user.
 - `DELETE /api/users/:id`: Delete a user (Soft Delete).
-<%_ } -%>
-
+<%_ if (auth.includes('JWT')) { %>
+### 🔐 Auth Endpoints:
+- `POST /api/auth/login`: Exchange credentials for a short-lived `accessToken` and a long-lived `refreshToken`.
+- `POST /api/auth/refresh`: Submit a `refreshToken` to receive a new pair of tokens. (Includes theft-detection logic).
+- `POST /api/auth/logout`: Revoke (blacklist) the active `accessToken` and delete the `refreshToken`.
+- `POST /api/users`: Acts as Sign Up when password is provided.
+  *Note: To access protected user endpoints (GET/PATCH/DELETE), include `Authorization: Bearer <your_accessToken>` in the headers.*
+<% } -%>
+<% } -%>
 <% if (communication === 'Kafka') { -%>
 ## 📡 Testing Kafka Asynchronous Flow
 This project demonstrates a production-ready Kafka flow:
-1. **Producer**: When a user is created via the API, a `USER_CREATED` event is sent to `user-topic`.
-2. **Consumer**: `WelcomeEmailConsumer` listens to `user-topic` and simulates sending an email.
+1. **Producer**: When a user is created, updated, or deleted via the API, a corresponding event (`USER_CREATED`, `USER_UPDATED`, `USER_DELETED`) is sent to `user-topic`.
+2. **Consumer**: `WelcomeEmailConsumer` listens to `user-topic` and simulates processing (e.g., sending an email on creation).
 
 ### How to verify:
 1. Ensure infrastructure is running: `docker-compose up -d<% if (database !== 'None') { %> db<% } %><% if (caching === 'Redis') { %> redis<% } %><% if (communication === 'Kafka') { %> kafka<% } %>`
 2. Start the app: `npm run dev`
-3. Trigger an event by creating a user (via Postman or curl):
-   ```bash
-   curl -X POST http://localhost:3000/api/users \
-     -H "Content-Type: application/json" \
-     -d '{"name": "Kafka Tester", "email": "kafka@example.com"}'
-   ```
+3. Trigger internal events:
+ 
+**Create User (Sign Up - Public):**
+```bash
+curl -X POST http://localhost:3000/api/users \
+  -H "Content-Type: application/json" \
+  -d '{"name": "Kafka Tester", "email": "kafka@example.com"<%_ if (auth.includes('JWT')) { _%>, "password": "password123"<%_ } _%>}'
+```
+
+<%_ if (auth.includes('JWT')) { _%>
+**Update User (Protected - Requires Auth):**
+1. Login to get token: `POST /api/auth/login`
+2. Update user with token:
+```bash
+curl -X PATCH http://localhost:3000/api/users/1 \
+  -H "Authorization: Bearer <YOUR_TOKEN>" \
+  -H "Content-Type: application/json" \
+  -d '{"name": "Updated Name"}'
+```
+<%_ } else { _%>
+**Update User:**
+```bash
+curl -X PATCH http://localhost:3000/api/users/1 \
+  -H "Content-Type: application/json" \
+  -d '{"name": "Updated Name"}'
+```
+<%_ } _%>
 4. Observe the logs:
-   ```text
-   [Kafka] Producer: Sent USER_CREATED event for 'kafka@example.com'
-   [Kafka] Consumer: Received USER_CREATED. 
-   [Kafka] Consumer: 📧 Sending welcome email to 'kafka@example.com'... Done!
-   ```
+```text
+[Kafka] Producer: Sent USER_CREATED event for 'kafka@example.com'
+[Kafka] Consumer: Received USER_CREATED. 
+[Kafka] Consumer: 📧 Sending welcome email to 'kafka@example.com'... Done!
+```
 
 ### 🛠️ Kafka Troubleshooting
 If the connection or events are failing:

package/templates/common/_circleci/config.yml.ejs

@@ -0,0 +1,96 @@
+version: 2.1
+
+orbs:
+  node: circleci/node@5.2.0
+<% if (includeSecurity) { %>
+  snyk: snyk/snyk@2.1.0
+<% } %>
+
+executors:
+  node-executor:
+    docker:
+      - image: cimg/node:22.0
+  machine-executor:
+    machine:
+      image: ubuntu-2204:current
+
+jobs:
+  lint:
+    executor: node-executor
+    steps:
+      - checkout
+      - node/install-packages
+      - run: npm run lint
+
+  unit_test:
+    executor: node-executor
+    steps:
+      - checkout
+      - node/install-packages
+      - run:
+          name: Run Unit Tests with Coverage
+          command: npm run test:coverage -- --maxWorkers=2
+
+  e2e_test:
+    executor: machine-executor
+    steps:
+      - checkout
+      - node/install:
+          node-version: '22.0'
+      - run: npm ci
+      - run: npm run test:e2e
+
+<% if (includeSecurity) { %>
+  security_scan:
+    executor: node-executor
+    steps:
+      - checkout
+      - node/install-packages
+      - snyk/scan:
+          fail-on-issues: true
+          severity-threshold: high
+
+  sonarqube_analysis:
+    executor: node-executor
+    steps:
+      - checkout
+      - node/install-packages
+      - run:
+          name: SonarQube Analysis
+          command: |
+            # Assuming sonar-scanner is available or run via npx
+            npx sonar-scanner
+<% } %>
+
+  build:
+    executor: node-executor
+    steps:
+      - checkout
+      - node/install-packages
+      - run: npm run build --if-present
+
+workflows:
+  build_and_test:
+    jobs:
+      - lint
+      - unit_test:
+          requires:
+            - lint
+      - e2e_test:
+          requires:
+            - unit_test
+<% if (includeSecurity) { %>
+      - security_scan:
+          requires:
+            - unit_test
+      - sonarqube_analysis:
+          requires:
+            - unit_test
+<% } %>
+      - build:
+          requires:
+            - e2e_test
+<% if (includeSecurity) { %>
+            - security_scan
+            - sonarqube_analysis
+<% } %>

package/templates/common/_github/workflows/ci.yml.ejs

@@ -30,7 +30,7 @@ jobs:
       run: npm run lint
       
     - name: Run Unit Tests
-      run: npm run test:coverage
+      run: npm run test:coverage -- --maxWorkers=2
       
     - name: Run E2E Tests
       run: npm run test:e2e

package/templates/common/auth/js/controllers/authController.js.ejs

@@ -0,0 +1,168 @@
+const bcrypt = require('bcryptjs');
+<% if (architecture === 'MVC') { -%>
+const User = require('../models/User');
+const JwtService = require('../services/jwtService');
+<% if (caching !== 'None') { -%>
+const cacheService = require('<% if (caching === "Redis") { %>../config/redisClient<% } else { %>../config/memoryCache<% } %>');
+<% } -%>
+const logger = require('../utils/logger');
+<% } else { -%>
+const User = require('../../../infrastructure/database/models/User');
+const JwtService = require('../../../infrastructure/auth/jwtService');
+<% if (caching !== 'None') { -%>
+const cacheService = require('<% if (caching === "Redis") { %>../../../infrastructure/caching/redisClient<% } else { %>../../../infrastructure/caching/memoryCache<% } %>');
+<% } -%>
+const logger = require('../../../infrastructure/log/logger');
+<% } -%>
+const HTTP_STATUS = require('<% if (architecture === "MVC") { %>../utils/httpCodes<% } else { %>../../../utils/httpCodes<% } %>');
+
+class AuthController {
+  constructor() {
+    this.login = this.login.bind(this);
+    this.refresh = this.refresh.bind(this);
+    this.logout = this.logout.bind(this);
+  }
+
+  async login(req, res, next) {
+    try {
+      const { email, password } = req.body;
+      <% if (database === 'MongoDB' || database === 'None') { %>
+      const user = await User.findOne({ email });
+      <% } else { %>
+      const user = await User.findOne({ where: { email } });
+      <% } %>
+      if (!user) {
+        return res.status(HTTP_STATUS.UNAUTHORIZED).json({ message: 'Invalid credentials' });
+      }
+
+      const isPasswordValid = await bcrypt.compare(password, user.password);
+      if (!isPasswordValid) {
+        return res.status(HTTP_STATUS.UNAUTHORIZED).json({ message: 'Invalid credentials' });
+      }
+
+      const userId = String(user.id || user._id);
+      const refreshToken = JwtService.generateRefreshToken({ id: userId, email: user.email });
+      const refreshJti = JwtService.decodeToken(refreshToken)?.jti;
+      const accessToken = JwtService.generateToken({ id: userId, email: user.email, sid: refreshJti });
+
+      <% if (caching !== 'None') { %>
+      const cacheKey = `refresh_tokens:${userId}`;
+      const activeTokens = await cacheService.get(cacheKey) || [];
+      activeTokens.push(refreshJti);
+      await cacheService.set(cacheKey, activeTokens, 7 * 24 * 60 * 60);
+      <% } else { -%>
+      const activeTokens = JwtService.activeRefreshTokens.get(userId) || [];
+      activeTokens.push(refreshJti);
+      JwtService.activeRefreshTokens.set(userId, activeTokens);
+      <% } %>
+
+      res.json({ token: accessToken, accessToken, refreshToken });
+    } catch (error) {
+      logger.error('Login error:', error);
+      next(error);
+    }
+  }
+
+  async refresh(req, res, next) {
+    try {
+      const { refreshToken } = req.body;
+      if (!refreshToken) {
+        return res.status(HTTP_STATUS.BAD_REQUEST).json({ message: 'Refresh token is required' });
+      }
+
+      const decoded = JwtService.verifyRefreshToken(refreshToken);
+      if (!decoded || !decoded.id || !decoded.jti) {
+        return res.status(HTTP_STATUS.UNAUTHORIZED).json({ message: 'Invalid refresh token' });
+      }
+
+      const userId = String(decoded.id);
+      const incomingJti = decoded.jti;
+
+      <% if (caching !== 'None') { %>
+      const cacheKey = `refresh_tokens:${userId}`;
+      let activeTokens = await cacheService.get(cacheKey) || [];
+      
+      if (!activeTokens.includes(incomingJti)) {
+        logger.warn(`Token theft detected for user ${userId}. Revoking all sessions.`);
+        await cacheService.del(cacheKey);
+        return res.status(HTTP_STATUS.UNAUTHORIZED).json({ message: 'Invalid session' });
+      }
+
+      activeTokens = activeTokens.filter(t => t !== incomingJti);
+      const newRefreshToken = JwtService.generateRefreshToken({ id: userId, email: decoded.email });
+      const newRefreshJti = JwtService.decodeToken(newRefreshToken)?.jti;
+      const newAccessToken = JwtService.generateToken({ id: userId, email: decoded.email, sid: newRefreshJti });
+      
+      activeTokens.push(newRefreshJti);
+      await cacheService.set(cacheKey, activeTokens, 7 * 24 * 60 * 60);
+      <% } else { -%>
+      let activeTokens = JwtService.activeRefreshTokens.get(userId) || [];
+      
+      if (!activeTokens.includes(incomingJti)) {
+        logger.warn(`Token theft detected for user ${userId}. Revoking all sessions.`);
+        JwtService.activeRefreshTokens.delete(userId);
+        return res.status(HTTP_STATUS.UNAUTHORIZED).json({ message: 'Invalid session' });
+      }
+
+      activeTokens = activeTokens.filter(t => t !== incomingJti);
+      const newRefreshToken = JwtService.generateRefreshToken({ id: userId, email: decoded.email });
+      const newRefreshJti = JwtService.decodeToken(newRefreshToken)?.jti;
+      const newAccessToken = JwtService.generateToken({ id: userId, email: decoded.email, sid: newRefreshJti });
+      
+      activeTokens.push(newRefreshJti);
+      JwtService.activeRefreshTokens.set(userId, activeTokens);
+      <% } %>
+      res.json({ accessToken: newAccessToken, refreshToken: newRefreshToken });
+    } catch (error) {
+      logger.error('Refresh token error:', error);
+      next(error);
+    }
+  }
+
+  async logout(req, res, next) {
+    try {
+      const authHeader = req.headers.authorization;
+      if (!authHeader) {
+        return res.status(HTTP_STATUS.BAD_REQUEST).json({ message: 'No token provided' });
+      }
+
+      const accessTokenStr = authHeader.split(' ')[1];
+      const decodedAccess = JwtService.decodeToken(accessTokenStr);
+      
+      if (decodedAccess && decodedAccess.jti && decodedAccess.exp) {
+        const remainingTime = Math.max(0, decodedAccess.exp - Math.floor(Date.now() / 1000));
+        <%_ if (caching !== 'None') { -%>
+        if (remainingTime > 0) {
+            await cacheService.set(`blacklist:${decodedAccess.jti}`, true, remainingTime);
+        }<%_ } else { -%>
+        if (remainingTime > 0) {
+            JwtService.blacklistedTokens.set(decodedAccess.jti, Date.now() + remainingTime * 1000);
+        }<%_ } -%>
+      }
+
+      const { refreshToken } = req.body;
+      if (refreshToken) {
+        const decodedRefresh = JwtService.decodeToken(refreshToken);
+        if (decodedRefresh && decodedRefresh.id && decodedRefresh.jti) {
+           const userId = String(decodedRefresh.id);
+           <%_ if (caching !== 'None') { -%>
+           const cacheKey = `refresh_tokens:${userId}`;
+           let activeTokens = await cacheService.get(cacheKey) || [];
+           activeTokens = activeTokens.filter(t => t !== decodedRefresh.jti);
+           await cacheService.set(cacheKey, activeTokens, 7 * 24 * 60 * 60);
+           <%_ } else { -%>
+           let activeTokens = JwtService.activeRefreshTokens.get(userId) || [];
+           activeTokens = activeTokens.filter(t => t !== decodedRefresh.jti);
+           JwtService.activeRefreshTokens.set(userId, activeTokens);<% } %>
+        }
+      }
+
+      res.json({ message: 'Logged out successfully' });
+    } catch (error) {
+      logger.error('Logout error:', error);
+      next(error);
+    }
+  }
+}
+
+module.exports = AuthController;