nodejs-structure-cli 1.0.0

package/templates/clean-architecture/js/src/interfaces/controllers/userController.spec.js.ejs

@@ -0,0 +1,234 @@
+const UserController = require('@/interfaces/controllers/userController');
+const ERROR_MESSAGES = require('@/utils/errorMessages');
+const CreateUser = require('@/usecases/CreateUser');
+const GetAllUsers = require('@/usecases/GetAllUsers');
+const UpdateUser = require('@/usecases/UpdateUser');
+const DeleteUser = require('@/usecases/DeleteUser');
+
+jest.mock('@/usecases/CreateUser');
+jest.mock('@/usecases/GetAllUsers');
+jest.mock('@/usecases/UpdateUser');
+jest.mock('@/usecases/DeleteUser');
+<%_ if (communication === 'Kafka') { -%>
+jest.mock('@/infrastructure/messaging/kafkaClient', () => ({
+    sendMessage: jest.fn().mockResolvedValue(undefined)
+}));
+<%_ } -%>
+
+
+describe('UserController (Clean Architecture)', () => {
+    let userController;
+    let mockCreateUserUseCase;
+    let mockGetAllUsersUseCase;
+    let mockUpdateUserUseCase;
+    let mockDeleteUserUseCase;
+<%_ if (communication !== 'GraphQL') { -%>
+    let mockRequest;
+    let mockResponse;
+    let mockNext;
+<%_ } -%>
+
+    beforeEach(() => {
+        jest.resetAllMocks();
+
+        userController = new UserController();
+
+        // Retrieve the mocked instances created inside UserController constructor
+        mockCreateUserUseCase = CreateUser.mock.instances[0];
+        mockGetAllUsersUseCase = GetAllUsers.mock.instances[0];
+        mockUpdateUserUseCase = UpdateUser.mock.instances[0];
+        mockDeleteUserUseCase = DeleteUser.mock.instances[0];
+
+<%_ if (communication !== 'GraphQL') { -%>
+        mockRequest = {
+            body: {},
+            params: {}
+        };
+        mockResponse = {
+            status: jest.fn().mockReturnThis(),
+            json: jest.fn()
+        };
+        mockNext = jest.fn();
+<%_ } -%>
+    });
+
+    describe('getUsers', () => {
+        it('should return successfully (Happy Path)', async () => {
+            const usersMock = [{ id: '1', name: 'Test', email: 'test@example.com' }];
+            mockGetAllUsersUseCase.execute.mockResolvedValue(usersMock);
+
+<%_ if (communication === 'GraphQL') { -%>
+            const result = await userController.getUsers();
+            expect(result).toEqual(usersMock);
+<%_ } else { -%>
+            await userController.getUsers(mockRequest, mockResponse, mockNext);
+            expect(mockResponse.json).toHaveBeenCalledWith(usersMock);
+<%_ } -%>
+            expect(mockGetAllUsersUseCase.execute).toHaveBeenCalled();
+        });
+
+        it('should handle errors correctly (Error Handling)', async () => {
+            const error = new Error('UseCase Error');
+            mockGetAllUsersUseCase.execute.mockRejectedValue(error);
+
+<%_ if (communication === 'GraphQL') { -%>
+            await expect(userController.getUsers()).rejects.toThrow(error);
+<%_ } else { -%>
+            await userController.getUsers(mockRequest, mockResponse, mockNext);
+            expect(mockNext).toHaveBeenCalledWith(error);
+<%_ } -%>
+        });
+    });
+
+    describe('createUser', () => {
+        it('should successfully create a new user (Happy Path)', async () => {
+            const payload = { name: 'Alice', email: 'alice@example.com' };
+<%_ if (communication === 'GraphQL') { -%>
+            const dataArg = payload;
+<%_ } else { -%>
+            mockRequest.body = payload;
+<%_ } -%>
+            const expectedUser = { id: '1', ...payload };
+            
+            mockCreateUserUseCase.execute.mockResolvedValue(expectedUser);
+
+<%_ if (communication === 'GraphQL') { -%>
+            const result = await userController.createUser(dataArg);
+            expect(result).toEqual(expectedUser);
+<%_ } else { -%>
+            await userController.createUser(mockRequest, mockResponse, mockNext);
+<%_ if (communication === 'Kafka') { -%>
+            const { sendMessage } = require('@/infrastructure/messaging/kafkaClient');
+            expect(sendMessage).toHaveBeenCalled();
+<%_ } -%>
+            expect(mockResponse.status).toHaveBeenCalledWith(201);
+
+            expect(mockResponse.json).toHaveBeenCalledWith(expectedUser);
+<%_ } -%>
+            expect(mockCreateUserUseCase.execute).toHaveBeenCalledWith(payload.name, payload.email);
+        });
+    });
+
+    describe('updateUser', () => {
+        it('should successfully update a user (Happy Path)', async () => {
+            const id = '1';
+            const payload = { name: 'Alice Updated' };
+<%_ if (communication === 'GraphQL') { -%>
+            const idArg = id;
+            const dataArg = payload;
+<%_ } else { -%>
+            mockRequest.params = { id };
+            mockRequest.body = payload;
+<%_ } -%>
+            const expectedUser = { id, ...payload };
+            
+            mockUpdateUserUseCase.execute.mockResolvedValue(expectedUser);
+
+<%_ if (communication === 'GraphQL') { -%>
+            const result = await userController.updateUser(idArg, dataArg);
+            expect(result.name).toBe(payload.name);
+<%_ } else { -%>
+            await userController.updateUser(mockRequest, mockResponse, mockNext);
+            expect(mockResponse.json).toHaveBeenCalled();
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+            const { sendMessage } = require('@/infrastructure/messaging/kafkaClient');
+            expect(sendMessage).toHaveBeenCalled();
+<%_ } -%>
+            expect(mockUpdateUserUseCase.execute).toHaveBeenCalledWith(id, payload);
+        });
+
+        it('should handle database errors during update (Error Handling)', async () => {
+            const id = '1';
+            const error = new Error('Database Error');
+            mockUpdateUserUseCase.execute.mockRejectedValue(error);
+<%_ if (communication === 'GraphQL') { -%>
+            await expect(userController.updateUser(id, { name: 'Fail' })).rejects.toThrow(error);
+<%_ } else { -%>
+            await userController.updateUser(mockRequest, mockResponse, mockNext);
+            expect(mockNext).toHaveBeenCalledWith(error);
+<%_ } -%>
+        });
+    });
+
+    describe('deleteUser', () => {
+        it('should successfully delete a user (Happy Path)', async () => {
+            const id = '1';
+<%_ if (communication === 'GraphQL') { -%>
+            const idArg = id;
+<%_ } else { -%>
+            mockRequest.params = { id };
+<%_ } -%>
+            mockDeleteUserUseCase.execute.mockResolvedValue(true);
+
+<%_ if (communication === 'GraphQL') { -%>
+            const result = await userController.deleteUser(idArg);
+            expect(result).toBe(true);
+<%_ } else { -%>
+            await userController.deleteUser(mockRequest, mockResponse, mockNext);
+            expect(mockResponse.status).toHaveBeenCalledWith(200);
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+            const { sendMessage } = require('@/infrastructure/messaging/kafkaClient');
+            expect(sendMessage).toHaveBeenCalled();
+<%_ } -%>
+            expect(mockDeleteUserUseCase.execute).toHaveBeenCalledWith(id);
+        });
+
+        it('should throw error if user not found during deletion (Error Handling)', async () => {
+            const id = '999';
+<%_ if (communication === 'GraphQL') { -%>
+            mockDeleteUserUseCase.execute.mockResolvedValue(false);
+            await expect(userController.deleteUser(id)).rejects.toThrow(ERROR_MESSAGES.USER_NOT_FOUND);
+<%_ } else { -%>
+            mockRequest.params = { id };
+            mockDeleteUserUseCase.execute.mockResolvedValue(false);
+            await userController.deleteUser(mockRequest, mockResponse, mockNext);
+            expect(mockResponse.status).toHaveBeenCalledWith(404);
+<%_ } -%>
+        });
+
+        it('should handle database errors during deletion (Error Handling)', async () => {
+            const id = '1';
+            const error = new Error('Database Error');
+            mockDeleteUserUseCase.execute.mockRejectedValue(error);
+<%_ if (communication === 'GraphQL') { -%>
+            await expect(userController.deleteUser(id)).rejects.toThrow(error);
+<%_ } else { -%>
+            mockRequest.params = { id };
+            await userController.deleteUser(mockRequest, mockResponse, mockNext);
+            expect(mockNext).toHaveBeenCalledWith(error);
+<%_ } -%>
+        });
+    });
+
+    describe('createUser Error Paths', () => {
+        it('should handle database errors during creation (Error Handling)', async () => {
+            const error = new Error('Database Error');
+            mockCreateUserUseCase.execute.mockRejectedValue(error);
+<%_ if (communication === 'GraphQL') { -%>
+            await expect(userController.createUser({ name: 'Alice', email: 'alice@example.com' })).rejects.toThrow(error);
+<%_ } else { -%>
+            mockRequest.body = { name: 'Alice', email: 'alice@example.com' };
+            await userController.createUser(mockRequest, mockResponse, mockNext);
+            expect(mockNext).toHaveBeenCalledWith(error);
+<%_ } -%>
+        });
+    });
+
+    describe('updateUser Error Paths', () => {
+        it('should handle database errors during update (Error Handling)', async () => {
+            const id = '1';
+            const error = new Error('Database Error');
+            mockUpdateUserUseCase.execute.mockRejectedValue(error);
+<%_ if (communication === 'GraphQL') { -%>
+            await expect(userController.updateUser(id, { name: 'Bob' })).rejects.toThrow(error);
+<%_ } else { -%>
+            mockRequest.params = { id };
+            mockRequest.body = { name: 'Bob' };
+            await userController.updateUser(mockRequest, mockResponse, mockNext);
+            expect(mockNext).toHaveBeenCalledWith(error);
+<%_ } -%>
+        });
+    });
+});

package/templates/clean-architecture/js/src/interfaces/graphql/context.js.ejs

@@ -0,0 +1,13 @@
+const UserRepository = require('../../infrastructure/repositories/UserRepository');
+
+const gqlContext = async ({ req }) => {
+  const token = req.headers.authorization || '';
+  const userRepository = new UserRepository();
+  
+  return { 
+    token, 
+    userRepository 
+  };
+};
+
+module.exports = { gqlContext };

package/templates/clean-architecture/js/src/interfaces/graphql/context.spec.js.ejs

@@ -0,0 +1,31 @@
+const { gqlContext } = require('@/interfaces/graphql/context');
+const { resolvers } = require('@/interfaces/graphql/resolvers');
+const { typeDefs } = require('@/interfaces/graphql/typeDefs');
+
+jest.mock('@/infrastructure/repositories/UserRepository');
+
+describe('GraphQL Context', () => {
+    it('should exercise GraphQL index entry points', () => {
+        expect(resolvers).toBeDefined();
+        expect(typeDefs).toBeDefined();
+    });
+  it('should return context with token when authorization header is present', async () => {
+    const mockRequest = {
+      headers: {
+        authorization: 'Bearer token123',
+      },
+    };
+
+    const context = await gqlContext({ req: mockRequest });
+    expect(context.token).toBe('Bearer token123');
+  });
+
+  it('should return context with empty token when authorization header is missing', async () => {
+    const mockRequest = {
+      headers: {},
+    };
+
+    const context = await gqlContext({ req: mockRequest });
+    expect(context.token).toBe('');
+  });
+});

package/templates/clean-architecture/js/src/interfaces/graphql/index.js.ejs

@@ -0,0 +1,5 @@
+const { typeDefs } = require('./typeDefs');
+const { resolvers } = require('./resolvers');
+const { gqlContext } = require('./context');
+
+module.exports = { typeDefs, resolvers, gqlContext };

package/templates/clean-architecture/js/src/interfaces/graphql/resolvers/index.js.ejs

@@ -0,0 +1,6 @@
+const { mergeResolvers } = require('@graphql-tools/merge');
+const { userResolvers } = require('./user.resolvers');
+
+const resolvers = mergeResolvers([userResolvers]);
+
+module.exports = { resolvers };

package/templates/clean-architecture/js/src/interfaces/graphql/resolvers/user.resolvers.js.ejs

@@ -0,0 +1,27 @@
+const UserController = require('../../controllers/userController');
+
+const userController = new UserController();
+
+const userResolvers = {
+  Query: {
+    getAllUsers: async () => {
+      return await userController.getUsers();
+    }
+  },
+  Mutation: {
+    createUser: async (_, { name, email }) => {
+      return await userController.createUser({ name, email });
+    },
+    updateUser: async (_, { id, name, email }) => {
+      return await userController.updateUser(id, { name, email });
+    },
+    deleteUser: async (_, { id }) => {
+      return await userController.deleteUser(id);
+    }
+  }<%_ if (database === 'MongoDB') { -%>,
+  User: {
+    id: (parent) => parent.id || parent._id
+  }<%_ } %>
+};
+
+module.exports = { userResolvers };

package/templates/clean-architecture/js/src/interfaces/graphql/resolvers/user.resolvers.spec.js.ejs

@@ -0,0 +1,66 @@
+const { userResolvers } = require('@/interfaces/graphql/resolvers/user.resolvers');
+
+const mockGetUsers = jest.fn().mockResolvedValue([{ id: '1', name: 'John Doe', email: 'john@example.com' }]);
+const mockCreateUser = jest.fn().mockResolvedValue({ id: '1', name: 'Jane', email: 'jane@example.com' });
+
+jest.mock('@/interfaces/controllers/userController', () => {
+  return jest.fn().mockImplementation(() => ({
+    getUsers: (...args) => mockGetUsers(...args),
+    createUser: (...args) => mockCreateUser(...args),
+    updateUser: jest.fn().mockImplementation((id, data) => Promise.resolve({ id, ...data })),
+    deleteUser: jest.fn().mockImplementation(() => Promise.resolve(true))
+  }));
+});
+
+describe('User Resolvers', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('Query.getAllUsers', () => {
+    it('should return all users', async () => {
+      const result = await userResolvers.Query.getAllUsers();
+      expect(result).toEqual([{ id: '1', name: 'John Doe', email: 'john@example.com' }]);
+      expect(mockGetUsers).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe('Mutation.createUser', () => {
+    it('should create and return a new user', async () => {
+      const result = await userResolvers.Mutation.createUser(null, { name: 'Jane', email: 'jane@example.com' });
+      expect(result).toEqual({ id: '1', name: 'Jane', email: 'jane@example.com' });
+      expect(mockCreateUser).toHaveBeenCalledWith({ name: 'Jane', email: 'jane@example.com' });
+      expect(mockCreateUser).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe('Mutation.updateUser', () => {
+    it('should update and return the user', async () => {
+      const payload = { name: 'Updated' };
+      const result = await userResolvers.Mutation.updateUser(null, { id: '1', ...payload });
+      expect(result).toMatchObject(payload);
+    });
+  });
+
+  describe('Mutation.deleteUser', () => {
+    it('should delete and return true', async () => {
+      const result = await userResolvers.Mutation.deleteUser(null, { id: '1' });
+      expect(result).toBe(true);
+    });
+  });
+<%_ if (database === 'MongoDB') { -%>
+  describe('User.id', () => {
+    it('should return parent.id if available', () => {
+      const parent = { id: '123' };
+      const result = userResolvers.User.id(parent);
+      expect(result).toBe('123');
+    });
+
+    it('should fallback to parent._id if id is not available', () => {
+      const parent = { _id: '456' };
+      const result = userResolvers.User.id(parent);
+      expect(result).toBe('456');
+    });
+  });
+<%_ } -%>
+});

package/templates/clean-architecture/js/src/interfaces/graphql/typeDefs/index.js.ejs

@@ -0,0 +1,6 @@
+const { mergeTypeDefs } = require('@graphql-tools/merge');
+const { userTypes } = require('./user.types');
+
+const typeDefs = mergeTypeDefs([userTypes]);
+
+module.exports = { typeDefs };

package/templates/clean-architecture/js/src/interfaces/graphql/typeDefs/user.types.js.ejs

@@ -0,0 +1,19 @@
+const userTypes = `#graphql
+  type User {
+    id: ID!
+    name: String!
+    email: String!
+  }
+
+  type Query {
+    getAllUsers: [User]
+  }
+
+  type Mutation {
+    createUser(name: String!, email: String!): User
+    updateUser(id: ID!, name: String, email: String): User
+    deleteUser(id: ID!): Boolean
+  }
+`;
+
+module.exports = { userTypes };

package/templates/clean-architecture/js/src/interfaces/routes/api.js.ejs

@@ -0,0 +1,17 @@
+const express = require('express');
+const router = express.Router();
+const UserController = require('../controllers/userController');
+<% if (auth && auth !== 'None') { %>const { authMiddleware } = require('../middleware/auth');<% } %>
+<% if (includeMulter) { %>const { upload } = require('../middleware/upload');<% } %>
+<% if (auth && auth !== 'None') { %>const authRoutes = require('./authRoutes');<% } %>
+
+const userController = new UserController();
+
+<% if (auth && auth !== 'None') { %>router.use('/auth', authRoutes);<% } %>
+
+router.get('/users', (req, res, next) => userController.getUsers(req, res, next));
+router.post('/users', <% if (includeMulter) { %>upload.single('image'), <% } %>(req, res, next) => userController.createUser(req, res, next));
+router.patch('/users/:id', <% if (includeMulter) { %>upload.single('image'), <% } %>(req, res, next) => userController.updateUser(req, res, next));
+router.delete('/users/:id', (req, res, next) => userController.deleteUser(req, res, next));
+
+module.exports = router;

package/templates/clean-architecture/js/src/interfaces/routes/api.spec.js.ejs

@@ -0,0 +1,38 @@
+const request = require('supertest');
+const express = require('express');
+const router = require('@/interfaces/routes/api');
+
+const mockGetUsers = jest.fn().mockImplementation((req, res) => res.status(200).json([{ id: '1', name: 'John Doe' }]));
+const mockCreateUser = jest.fn().mockImplementation((req, res) => res.status(201).json({ id: '1', name: 'Test' }));
+
+jest.mock('@/interfaces/controllers/userController', () => {
+  return jest.fn().mockImplementation(() => ({
+    getUsers: (...args) => mockGetUsers(...args),
+    createUser: (...args) => mockCreateUser(...args)
+  }));
+});
+
+describe('ApiRoutes', () => {
+    let app;
+
+    beforeEach(() => {
+        app = express();
+        app.use(express.json());
+        app.use('/api', router);
+    });
+
+    it('POST /api/users should call controller.createUser', async () => {
+        await request(app)
+            .post('/api/users')
+            .send({ name: 'Test', email: 'test@example.com' });
+
+        expect(mockCreateUser).toHaveBeenCalledTimes(1);
+    });
+
+    it('GET /api/users should call controller.getUsers', async () => {
+        await request(app)
+            .get('/api/users');
+
+        expect(mockGetUsers).toHaveBeenCalledTimes(1);
+    });
+});

package/templates/clean-architecture/js/src/usecases/CreateUser.js.ejs

@@ -0,0 +1,14 @@
+const User = require('../domain/models/User');
+
+class CreateUser {
+    constructor(userRepository) {
+        this.userRepository = userRepository;
+    }
+
+    async execute(name, email<% if (auth && auth !== 'None') { %>, password<% } %><% if (includeMulter) { %>, imageUrl<% } %>) {
+        const user = new User(null, name, email<% if (auth && auth !== 'None') { %>, password<% } %><% if (includeMulter) { %>, imageUrl<% } %>);
+        return await this.userRepository.save(user);
+    }
+}
+
+module.exports = CreateUser;

package/templates/clean-architecture/js/src/usecases/CreateUser.spec.js.ejs

@@ -0,0 +1,51 @@
+const CreateUser = require('@/usecases/CreateUser');
+const UserRepository = require('@/infrastructure/repositories/UserRepository');
+<%_ if (caching !== 'None') { -%>
+const cacheService = require('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>');
+<%_ } -%>
+
+jest.mock('@/infrastructure/repositories/UserRepository');
+<%_ if (caching !== 'None') { -%>
+jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
+    get: jest.fn(),
+    set: jest.fn(),
+    del: jest.fn()
+}));
+<%_ } -%>
+
+describe('CreateUser UseCase', () => {
+    let createUser;
+    let mockUserRepository;
+
+    beforeEach(() => {
+        mockUserRepository = new UserRepository();
+        createUser = new CreateUser(mockUserRepository);
+        jest.clearAllMocks();
+    });
+
+    it('should create and save a new user', async () => {
+        const name = 'Test User';
+        const email = 'test@example.com';
+        const expectedResult = { id: 1, name, email };
+
+        mockUserRepository.save.mockResolvedValue(expectedResult);
+
+        const result = await createUser.execute(name, email);
+
+        expect(mockUserRepository.save).toHaveBeenCalledTimes(1);
+        const savedUser = mockUserRepository.save.mock.calls[0][0];
+        expect(savedUser.name).toBe(name);
+        expect(savedUser.email).toBe(email);
+        expect(result).toEqual(expectedResult);
+<%_ if (caching !== 'None') { -%>
+        expect(cacheService.del).toHaveBeenCalledWith('users:all');
+<%_ } -%>
+    });
+
+    it('should throw an error if repository fails', async () => {
+        const error = new Error('Database error');
+        mockUserRepository.save.mockRejectedValue(error);
+
+        await expect(createUser.execute('Test', 'test@test.com')).rejects.toThrow(error);
+    });
+});

package/templates/clean-architecture/js/src/usecases/DeleteUser.js

@@ -0,0 +1,11 @@
+class DeleteUser {
+  constructor(userRepository) {
+    this.userRepository = userRepository;
+  }
+
+  async execute(id) {
+    return this.userRepository.delete(id);
+  }
+}
+
+module.exports = DeleteUser;

package/templates/clean-architecture/js/src/usecases/DeleteUser.spec.js.ejs

@@ -0,0 +1,47 @@
+const DeleteUser = require('@/usecases/DeleteUser');
+const UserRepository = require('@/infrastructure/repositories/UserRepository');
+<%_ if (caching !== 'None') { -%>
+const cacheService = require('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>');
+<%_ } -%>
+
+jest.mock('@/infrastructure/repositories/UserRepository');
+<%_ if (caching !== 'None') { -%>
+jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
+    get: jest.fn(),
+    set: jest.fn(),
+    del: jest.fn()
+}));
+<%_ } -%>
+
+describe('DeleteUser UseCase', () => {
+    let deleteUser;
+    let mockUserRepository;
+
+    beforeEach(() => {
+        mockUserRepository = new UserRepository();
+        deleteUser = new DeleteUser(mockUserRepository);
+        jest.clearAllMocks();
+    });
+
+    it('should delete and return the user', async () => {
+        const id = 1;
+        const expectedResult = { id, name: 'Deleted User', email: 'test@test.com' };
+
+        mockUserRepository.delete.mockResolvedValue(expectedResult);
+
+        const result = await deleteUser.execute(id);
+
+        expect(mockUserRepository.delete).toHaveBeenCalledWith(id);
+        expect(result).toEqual(expectedResult);
+<%_ if (caching !== 'None') { -%>
+        expect(cacheService.del).toHaveBeenCalledWith('users:all');
+<%_ } %>
+    });
+
+    it('should throw an error if repository fails', async () => {
+        const error = new Error('Database error');
+        mockUserRepository.delete.mockRejectedValue(error);
+
+        await expect(deleteUser.execute(1)).rejects.toThrow(error);
+    });
+});

package/templates/clean-architecture/js/src/usecases/GetAllUsers.js

@@ -0,0 +1,12 @@
+
+class GetAllUsers {
+    constructor(userRepository) {
+        this.userRepository = userRepository;
+    }
+
+    async execute() {
+        return await this.userRepository.getUsers();
+    }
+}
+
+module.exports = GetAllUsers;