nodejs-quickstart-structure 2.0.0 → 2.1.0

package/templates/common/caching/clean/ts/createUser.ts.ejs

@@ -1,18 +1,26 @@
 import { User } from '@/domain/user';
-
 import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-<%_ if (caching === 'Redis') { -%>
+<% if (auth.includes('JWT')) { -%>
+import bcrypt from 'bcryptjs';
+<% } -%>
+<% if (caching === 'Redis') { -%>
 import cacheService from '@/infrastructure/caching/redisClient';
-<%_ } else if (caching === 'Memory Cache') { -%>
+<% } else if (caching === 'Memory Cache') { -%>
 import cacheService from '@/infrastructure/caching/memoryCache';
-<%_ } -%>
+<% } -%>
 import logger from '@/infrastructure/log/logger';
 
 export default class CreateUser {
     constructor(private userRepository: UserRepository) {}
 
-    async execute(name: string, email: string) {
-        const user = new User(null, name, email);
+    async execute(name: string, email: string, password?: string) {
+        let finalPassword = password;
+<% if (auth.includes('JWT')) { -%>
+        if (password) {
+            finalPassword = await bcrypt.hash(password, 10);
+        }
+<% } -%>
+        const user = new User(null, name, email, finalPassword);
         const savedUser = await this.userRepository.save(user);
 
         try {

package/templates/common/caching/clean/ts/deleteUser.ts.ejs

@@ -14,7 +14,8 @@ export default class DeleteUser {
 
         try {
             await cacheService.del('users:all');
-            logger.info('Invalidated users:all cache');
+            await cacheService.del(`user:${id}`);
+            logger.info(`Invalidated cache for user:${id} and all users`);
         } catch (error) {
             logger.error('Cache error (del):', error);
         }

package/templates/common/caching/clean/ts/getUserById.ts.ejs

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

package/templates/common/caching/clean/ts/updateUser.ts.ejs

@@ -1,4 +1,3 @@
-import { User } from '@/domain/user';
 import { UserRepository } from '@/infrastructure/repositories/UserRepository';
 <%_ if (caching === 'Redis') { -%>
 import cacheService from '@/infrastructure/caching/redisClient';
@@ -15,7 +14,8 @@ export default class UpdateUser {
 
         try {
             await cacheService.del('users:all');
-            logger.info('Invalidated users:all cache');
+            await cacheService.del(`user:${id}`);
+            logger.info(`Invalidated cache for user:${id} and all users`);
         } catch (error) {
             logger.error('Cache error (del):', error);
         }

package/templates/common/database/js/models/User.js.ejs

@@ -6,12 +6,18 @@ class UserModel {
     return this.mockData;
   }
 
+  static async findOne(query) {
+    return this.mockData.find((u) => {
+      return Object.entries(query).every(([key, value]) => u[key] === value);
+    });
+  }
+
   static async findAll() {
     return this.mockData;
   }
 
   static async create(data) {
-    const { id, ...rest } = data;
+    const { id: _, ...rest } = data;
     const newUser = { id: String(this.mockData.length + 1), ...rest };
     this.mockData.push(newUser);
     return newUser;
@@ -62,6 +68,12 @@ User.init(
       allowNull: false,
       unique: true,
     },
+    <% if (auth.includes('JWT')) { %>
+    password: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    <% } %>
     deletedAt: {
       type: DataTypes.DATE,
       allowNull: true,
@@ -75,5 +87,6 @@ User.init(
   }
 );
 
+
 module.exports = User;
 <% } -%>

package/templates/common/database/js/models/User.js.mongoose.ejs

@@ -10,6 +10,12 @@ const UserSchema = new mongoose.Schema({
         required: true,
         unique: true
     },
+    <% if (auth.includes('JWT')) { %>
+    password: {
+        type: String,
+        required: true
+    },
+    <% } %>
     createdAt: {
         type: Date,
         default: Date.now
@@ -20,4 +26,5 @@ const UserSchema = new mongoose.Schema({
     }
 });
 
+
 module.exports = mongoose.model('User', UserSchema);

package/templates/common/database/js/models/User.spec.js.ejs

@@ -73,15 +73,27 @@ describe('User Model', () => {
         expect(await User.find()).toBeDefined();
         expect(await User.findAll()).toBeDefined();
         
+        // Test findOne
+        const oneUser = await User.findOne({ email: data.email });
+        expect(oneUser.email).toBe(data.email);
+        
         const found = await User.findByPk(user.id);
         expect(found.id).toBe(user.id);
         
         const updated = await User.update(user.id, { name: 'New Name' });
         expect(updated.name).toBe('New Name');
         
+        // Test update non-existent
+        const nonExistentUpdate = await User.update('999', { name: 'Fail' });
+        expect(nonExistentUpdate).toBeUndefined();
+
         const deleted = await User.destroy(user.id);
         expect(deleted).toBe(true);
         expect(await User.findByPk(user.id)).toBeUndefined();
+
+        // Test destroy non-existent
+        const notDeleted = await User.destroy('999');
+        expect(notDeleted).toBe(false);
         <% } else { %>
         User.create.mockResolvedValue({ id: 1, ...data });
         User.findAll.mockResolvedValue([{ id: 1, ...data }]);

package/templates/common/database/ts/models/User.spec.ts.ejs

@@ -40,6 +40,11 @@ jest.mock('@/infrastructure/database/database', () => ({}));
 describe('User Model', () => {
     beforeEach(() => {
         jest.clearAllMocks();
+        <% if (database === 'None') { %>
+        const UserPath = '<% if (architecture === "MVC") { %>@/models/User<% } else { %>@/infrastructure/database/models/User<% } %>';
+        const User = require(UserPath).default;
+        User.mockData = [];
+        <% } %>
     });
 
     it('should be defined and initialized', () => {
@@ -78,6 +83,11 @@ describe('User Model', () => {
         expect(found).toEqual(user);
         expect(await User.findByPk('invalid')).toBeUndefined();
         
+        // findOne
+        const foundOne = await User.findOne({ email: data.email });
+        expect(foundOne).toEqual(user);
+        expect(await User.findOne({ email: 'nonexistent' })).toBeUndefined();
+        
         // update
         const updated = await User.update(user.id, { name: 'Updated' });
         expect(updated.name).toBe('Updated');

package/templates/common/database/ts/models/User.ts.ejs

@@ -3,6 +3,9 @@ export interface User {
   id: string;
   name: string;
   email: string;
+<% if (auth.includes('JWT')) { -%>
+  password?: string;
+<% } -%>
 }
 
 export default class UserModel {
@@ -12,6 +15,12 @@ export default class UserModel {
     return this.mockData;
   }
 
+  static async findOne(query: Partial<User>) {
+    return this.mockData.find((u) => {
+      return Object.entries(query).every(([key, value]) => (u as unknown as Record<string, unknown>)[key] === value);
+    });
+  }
+
   static async findAll() {
     return this.mockData;
   }
@@ -52,6 +61,7 @@ class User extends Model {
   public id!: number;
   public name!: string;
   public email!: string;
+  <% if (auth.includes('JWT')) { %>public password!: string;<% } %>
 }
 
 User.init(
@@ -70,6 +80,12 @@ User.init(
       allowNull: false,
       unique: true,
     },
+    <% if (auth.includes('JWT')) { %>
+    password: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    <% } %>
     deletedAt: {
       type: DataTypes.DATE,
       allowNull: true,
@@ -83,5 +99,6 @@ User.init(
   }
 );
 
+
 export default User;
 <% } -%>

package/templates/common/database/ts/models/User.ts.mongoose.ejs

@@ -3,6 +3,7 @@ import mongoose, { Schema, Document } from 'mongoose';
 export interface IUser extends Document {
     name: string;
     email: string;
+    <% if (auth.includes('JWT')) { %>password: string;<% } %>
     createdAt: Date;
     deletedAt?: Date | null;
 }
@@ -17,6 +18,12 @@ const UserSchema: Schema = new Schema({
         required: true,
         unique: true
     },
+    <% if (auth.includes('JWT')) { %>
+    password: {
+        type: String,
+        required: true
+    },
+    <% } %>
     createdAt: {
         type: Date,
         default: Date.now
@@ -27,4 +34,5 @@ const UserSchema: Schema = new Schema({
     }
 });
 
+
 export default mongoose.model<IUser>('User', UserSchema);

package/templates/common/docker-compose.yml.ejs

@@ -39,6 +39,12 @@ services:
       - DB_PORT=27017
 <%_ } -%>
 <%_ } -%>
+<%_ if (auth.includes('JWT')) { -%>
+      - JWT_SECRET=your_jwt_secret_key_here_change_it
+      - JWT_REFRESH_SECRET=your_jwt_refresh_secret_key_here_change_it
+      - JWT_EXPIRES_IN=1d
+      - JWT_REFRESH_EXPIRES_IN=7d
+<%_ } -%>
 <%_ } else { -%>
     environment:
       - PORT=3000
@@ -64,6 +70,12 @@ services:
       - DB_PORT=27017
 <%_ } -%>
 <%_ } -%>
+<%_ if (auth.includes('JWT')) { -%>
+      - JWT_SECRET=your_jwt_secret_key_here_change_it
+      - JWT_REFRESH_SECRET=your_jwt_refresh_secret_key_here_change_it
+      - JWT_EXPIRES_IN=1d
+      - JWT_REFRESH_EXPIRES_IN=7d
+<%_ } -%>
 <%_ } -%>
 <%_ if (database !== 'None') { -%>
   db:
@@ -122,10 +134,12 @@ services:
       FLYWAY_URL: jdbc:mysql://db:3306/<%= dbName %>
       FLYWAY_USER: root
       FLYWAY_PASSWORD: root
+      FLYWAY_BASELINE_ON_MIGRATE: "true"
 <%_ } -%><%_ if (database === 'PostgreSQL') { -%>
       FLYWAY_URL: jdbc:postgresql://db:5432/<%= dbName %>
       FLYWAY_USER: postgres
       FLYWAY_PASSWORD: root
+      FLYWAY_BASELINE_ON_MIGRATE: "true"
 <%_ } -%>
     depends_on:
       - db

package/templates/common/ecosystem.config.js.ejs

@@ -24,16 +24,22 @@ module.exports = {
       DB_USER: "root",
       DB_PASSWORD: "root",
       DB_NAME: "<%= dbName %>",
-      DB_PORT: 3306
+      DB_PORT: 3306,
 <%_ } else if (database === 'PostgreSQL') { -%>
       DB_USER: "postgres",
       DB_PASSWORD: "root",
       DB_NAME: "<%= dbName %>",
-      DB_PORT: 5432
+      DB_PORT: 5432,
 <%_ } else if (database === 'MongoDB') { -%>
       DB_NAME: "<%= dbName %>",
-      DB_PORT: 27017
+      DB_PORT: 27017,
 <%_ } -%>
+<%_ } -%>
+<%_ if (auth.includes('JWT')) { -%>
+      JWT_SECRET: "your_jwt_secret_here",
+      JWT_REFRESH_SECRET: "your_jwt_refresh_secret_here",
+      JWT_EXPIRES_IN: "1h",
+      JWT_REFRESH_EXPIRES_IN: "7d",
 <%_ } -%>
     }
   }]

package/templates/common/eslint.config.mjs.ejs

@@ -19,6 +19,9 @@ export default tseslint.config(
       },
     },
     languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.json', './tsconfig.eslint.json'],
+      },
       globals: {
         ...globals.node,
         ...globals.jest,

package/templates/common/jest.config.js.ejs

@@ -11,15 +11,17 @@ module.exports = {
   coveragePathIgnorePatterns: [
     "/node_modules/",
     "/dist/",
-    "src/index",
-    "src/app",
-    "src/config/env",
-    "src/infrastructure/config/env",
-    "src/config/swagger",
-    "src/infrastructure/webserver/swagger",
-    "src/infrastructure/webserver/server",
-    "src/utils/logger",
-    "src/infrastructure/log/logger"
+    "src/index.(js|ts)",
+    "src/app.(js|ts)",
+    "src/config",
+    "src/infrastructure/config",
+    "src/routes",
+    "src/infrastructure/routes",
+    "src/interfaces/routes",
+    "src/graphql",
+    "src/interfaces/graphql",
+    "src/utils",
+    "src/models"
   ],
   coverageThreshold: {
     global: {

package/templates/common/kafka/js/messaging/baseConsumer.js.ejs

@@ -22,7 +22,7 @@ class BaseConsumer {
     }
   }
 
-  async handle(data) {
+  async handle(_data) {
     throw new Error("Method 'handle()' must be implemented");
   }
 }

package/templates/common/kafka/js/services/kafkaService.js.ejs

@@ -34,7 +34,7 @@ const connectKafka = async (retries = 10) => {
                     await consumer.run({
                         eachMessage: async (payload) => welcomeConsumer.onMessage(payload),
                     });
-                } catch (error) {
+                } catch {
                     // Fallback or no consumers found
                     await consumer.subscribe({ topic: 'user-topic', fromBeginning: true });
                     await consumer.run({

package/templates/common/migrations/init.js.ejs

@@ -1,5 +1,5 @@
 module.exports = {
-  async up(db, client) {
+  async up(db, _client) {
     const adminEmail = 'admin@example.com';
     const existingAdmin = await db.collection('users').findOne({ email: adminEmail });
 
@@ -7,16 +7,17 @@ module.exports = {
       await db.collection('users').insertOne({
         name: 'Admin User',
         email: adminEmail,
+        <% if (auth.includes('JWT')) { %>password: '$2a$10$X.fO9PeyF0Lq0lF8uV6G9u4Vb4e5T0rF8l/JzM6S7X9u4Vb4e5T0r', // password: password123<% } %>
         createdAt: new Date(),
         updatedAt: new Date()
       });
-      console.log('Admin User seeded successfully');
+      console.log('Admin User seeded successfully'); // eslint-disable-line no-console
     } else {
-      console.log('Admin User already exists, skipping seed');
+      console.log('Admin User already exists, skipping seed'); // eslint-disable-line no-console
     }
   },
 
-  async down(db, client) {
+  async down(_db, _client) {
     // Optional: Undo the seed. Usually for seeds we might want to keep data, but strictly speaking 'down' should reverse 'up'.
     // await db.collection('users').deleteOne({ email: 'admin@example.com' });
   }

package/templates/common/package.json.ejs

@@ -28,7 +28,8 @@
     "micromatch": "^4.0.8",
     "braces": "^3.0.3",
     "picomatch": "^4.0.4",
-    "lodash": "^4.17.23"
+    "lodash": "^4.17.23",
+    "debounce": "^1.2.1"
   },
   "dependencies": {
     "express": "^4.18.2",
@@ -52,8 +53,12 @@
 <% if (viewEngine === 'EJS') { %>    "ejs": "^3.1.10",
 <% } -%>
 <% if (viewEngine === 'Pug') { %>    "pug": "^3.0.2",
+<% } -%>
+<% if (auth.includes('JWT')) { %>    "jsonwebtoken": "^9.0.2",
+    "bcryptjs": "^2.4.3",
 <% } -%>
     "cors": "^2.8.5",
+
     "helmet": "^7.1.0",
     "hpp": "^0.2.3",
     "express-rate-limit": "^7.1.5",
@@ -84,7 +89,10 @@
 <% } -%>
     "@types/morgan": "^1.9.9",
     "rimraf": "^6.0.1"<% if ((viewEngine && viewEngine !== 'None') || communication === 'REST APIs' || communication === 'Kafka') { %>,
-    "cpx2": "^8.0.0"<% } %><% } %>,
+    "cpx2": "^8.0.0"<% } %><% if (auth.includes('JWT')) { %>,
+    "@types/jsonwebtoken": "^9.0.6",
+    "@types/bcryptjs": "^2.4.6"<% } %><% } %>,
+
     "eslint": "^10.1.0",
     "@eslint/js": "^9.20.0",
     "globals": "^15.14.0",

package/templates/common/prompts/project-context.md.ejs

@@ -16,6 +16,9 @@ You are an expert working on **<%= projectName %>**.
 <% if (caching !== 'None') { -%>
 - **Caching**: <%= caching %>
 <% } -%>
+<% if (auth.includes('JWT')) { -%>
+- **Authentication**: JWT (Access & Refresh Tokens)
+<% } -%>
 
 ## High-Level Architecture
 <% if (architecture === 'Clean Architecture') { -%>
@@ -34,7 +37,11 @@ We use the MVC (Model-View-Controller) pattern.
 ## Core Standards
 1. **Testing**: We enforce > 80% coverage. Tests use Jest and the AAA (Arrange, Act, Assert) pattern.
 2. **Error Handling**: We use centralized custom errors (e.g., `ApiError`) and global error middleware. Status codes come from standard constants, not hardcoded numbers.
-3. **Paths & Naming**:
+3. **Security**: 
+   <% if (auth.includes('JWT')) { %>- Use `authMiddleware` for protected routes.<% } %>
+   - Validate and sanitize all inputs to prevent injection and XSS.
+   - Never expose sensitive data (passwords, inner keys) in API responses.
+4. **Paths & Naming**:
 <% if (language === 'TypeScript') { -%>
    - We use `@/` path aliases for internal imports.
 <% } -%>

package/templates/common/scripts/run-e2e.js.ejs

@@ -3,13 +3,21 @@ const { execSync } = require('child_process');
 const path = require('path');
 
 // Set a specific port for E2E tests to avoid collisions with local development
-process.env.PORT = '3001';
-const TEST_PORT = process.env.PORT;
+const TEST_PORT = <% if (database === 'MySQL') { %>process.env.PORT || '3001'<% } else { %>process.env.PORT || '3001'<% } %>;
+const WAIT_ON_HOST = process.env.WAIT_ON_HOST || '127.0.0.1';
 
 const execute = (command) => {
-    console.log(`\n> ${command}`);
-    // Run commands from the project root instead of the scripts folder
-    execSync(command, { stdio: 'inherit', cwd: path.resolve(__dirname, '../') });
+  console.log(`\n> ${command}`);
+  // Run commands from the project root instead of the scripts folder
+  execSync(command, { 
+    stdio: 'inherit', 
+    cwd: path.resolve(__dirname, '../'),
+    env: { 
+      ...process.env, 
+      PORT: TEST_PORT,
+      DB_PORT: process.env.DB_PORT || '3306'
+    }
+  });
 };
 
 let composeCmd = 'docker-compose';
@@ -26,7 +34,7 @@ try {
     let isAlreadyUp = false;
     try {
         // Silently check if the endpoint is already live (1.5-second timeout)
-        execSync(`npx wait-on http-get://127.0.0.1:${TEST_PORT}/health -t 1500`, { 
+        execSync(`npx wait-on http-get://${WAIT_ON_HOST}:${TEST_PORT}/health -t 1500`, { 
             stdio: 'ignore',
             cwd: path.resolve(__dirname, '../') 
         });
@@ -42,10 +50,18 @@ try {
         execute(`${composeCmd} up -d --build`);
         currentProcessStartedDocker = true;
 
-        console.log('Waiting for application healthcheck to turn green (120s timeout)...');
-        // Using wait-on to poll the universal /health endpoint injected into all architectures
-        execute(`npx wait-on http-get://127.0.0.1:${TEST_PORT}/health -t 120000`);
-        console.log('Infrastructure is healthy!');
+        console.log(`Waiting for application healthcheck to turn green (420s timeout)...`);
+        try {
+            // Using WAIT_ON_HOST to allow containerized CI to hit host ports (e.g. host.docker.internal)
+            execute(`npx wait-on http-get://${WAIT_ON_HOST}:${TEST_PORT}/health -t 420000`);
+            console.log('Infrastructure is healthy!');
+        } catch (e) {
+            console.error('\n❌ Healthcheck timed out! Printing infrastructure logs for debugging:');
+            console.error('------------------------------------------------------------');
+            execute(`${composeCmd} logs --tail=100`);
+            console.error('------------------------------------------------------------');
+            throw e;
+        }
     }
 
     console.log('Running E2E tests...');