nodejs-quickstart-structure 1.18.0 → 1.19.0

package/templates/mvc/js/src/errors/BadRequestError.js

@@ -1,10 +1,11 @@
-const { ApiError } = require('./ApiError');
-const HTTP_STATUS = require('../utils/httpCodes');
-
-class BadRequestError extends ApiError {
-  constructor(message = 'Bad request') {
-    super(HTTP_STATUS.BAD_REQUEST, message);
-  }
-}
-
-module.exports = { BadRequestError };
+const { ApiError } = require('./ApiError');
+const HTTP_STATUS = require('../utils/httpCodes');
+const ERROR_MESSAGES = require('../utils/errorMessages');
+
+class BadRequestError extends ApiError {
+  constructor(message = ERROR_MESSAGES.BAD_REQUEST) {
+    super(HTTP_STATUS.BAD_REQUEST, message);
+  }
+}
+
+module.exports = { BadRequestError };

package/templates/mvc/js/src/errors/BadRequestError.spec.js.ejs

@@ -1,21 +1,22 @@
-const { BadRequestError } = require('@/errors/BadRequestError');
-const { ApiError } = require('@/errors/ApiError');
-const HTTP_STATUS = require('@/utils/httpCodes');
-
-describe('BadRequestError', () => {
-    it('should extend ApiError', () => {
-        const error = new BadRequestError();
-        expect(error).toBeInstanceOf(ApiError);
-    });
-
-    it('should have default message "Bad request"', () => {
-        const error = new BadRequestError();
-        expect(error.message).toBe('Bad request');
-        expect(error.statusCode).toBe(HTTP_STATUS.BAD_REQUEST);
-    });
-
-    it('should accept a custom message', () => {
-        const error = new BadRequestError('Custom bad request');
-        expect(error.message).toBe('Custom bad request');
-    });
-});
+const { BadRequestError } = require('@/errors/BadRequestError');
+const { ApiError } = require('@/errors/ApiError');
+const HTTP_STATUS = require('@/utils/httpCodes');
+const ERROR_MESSAGES = require('@/utils/errorMessages');
+
+describe('BadRequestError', () => {
+    it('should extend ApiError', () => {
+        const error = new BadRequestError();
+        expect(error).toBeInstanceOf(ApiError);
+    });
+
+    it('should have default message "Bad Request"', () => {
+        const error = new BadRequestError();
+        expect(error.message).toBe(ERROR_MESSAGES.BAD_REQUEST);
+        expect(error.statusCode).toBe(HTTP_STATUS.BAD_REQUEST);
+    });
+
+    it('should accept a custom message', () => {
+        const error = new BadRequestError('Custom bad request');
+        expect(error.message).toBe('Custom bad request');
+    });
+});

package/templates/mvc/js/src/errors/NotFoundError.js

@@ -1,10 +1,11 @@
-const { ApiError } = require('./ApiError');
-const HTTP_STATUS = require('../utils/httpCodes');
-
-class NotFoundError extends ApiError {
-  constructor(message = 'Resource not found') {
-    super(HTTP_STATUS.NOT_FOUND, message);
-  }
-}
-
-module.exports = { NotFoundError };
+const { ApiError } = require('./ApiError');
+const HTTP_STATUS = require('../utils/httpCodes');
+const ERROR_MESSAGES = require('../utils/errorMessages');
+
+class NotFoundError extends ApiError {
+  constructor(message = ERROR_MESSAGES.RESOURCE_NOT_FOUND) {
+    super(HTTP_STATUS.NOT_FOUND, message);
+  }
+}
+
+module.exports = { NotFoundError };

package/templates/mvc/js/src/errors/NotFoundError.spec.js.ejs

@@ -1,21 +1,22 @@
-const { NotFoundError } = require('@/errors/NotFoundError');
-const { ApiError } = require('@/errors/ApiError');
-const HTTP_STATUS = require('@/utils/httpCodes');
-
-describe('NotFoundError', () => {
-    it('should extend ApiError', () => {
-        const error = new NotFoundError();
-        expect(error).toBeInstanceOf(ApiError);
-    });
-
-    it('should have default message "Resource not found"', () => {
-        const error = new NotFoundError();
-        expect(error.message).toBe('Resource not found');
-        expect(error.statusCode).toBe(HTTP_STATUS.NOT_FOUND);
-    });
-
-    it('should accept a custom message', () => {
-        const error = new NotFoundError('User not found');
-        expect(error.message).toBe('User not found');
-    });
-});
+const { NotFoundError } = require('@/errors/NotFoundError');
+const { ApiError } = require('@/errors/ApiError');
+const HTTP_STATUS = require('@/utils/httpCodes');
+const ERROR_MESSAGES = require('@/utils/errorMessages');
+
+describe('NotFoundError', () => {
+    it('should extend ApiError', () => {
+        const error = new NotFoundError();
+        expect(error).toBeInstanceOf(ApiError);
+    });
+
+    it('should have default message "Resource not found"', () => {
+        const error = new NotFoundError();
+        expect(error.message).toBe(ERROR_MESSAGES.RESOURCE_NOT_FOUND);
+        expect(error.statusCode).toBe(HTTP_STATUS.NOT_FOUND);
+    });
+
+    it('should accept a custom message', () => {
+        const error = new NotFoundError(ERROR_MESSAGES.USER_NOT_FOUND);
+        expect(error.message).toBe(ERROR_MESSAGES.USER_NOT_FOUND);
+    });
+});

package/templates/mvc/js/src/graphql/resolvers/user.resolvers.js.ejs

@@ -1,19 +1,25 @@
-const userController = require('../../controllers/userController');
-
-const userResolvers = {
-  Query: {
-    getAllUsers: async () => {
-      return await userController.getUsers();
-    }
-  },
-  Mutation: {
-    createUser: async (_, { name, email }) => {
-      return await userController.createUser({ name, email });
-    }
-  }<%_ if (database === 'MongoDB') { -%>,
-  User: {
-    id: (parent) => parent.id || parent._id
-  }<%_ } %>
-};
-
-module.exports = { userResolvers };
+const userController = require('../../controllers/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/mvc/js/src/graphql/resolvers/user.resolvers.spec.js.ejs

@@ -1,47 +1,64 @@
-const { userResolvers } = require('@/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('@/controllers/userController', () => ({
-  getUsers: (...args) => mockGetUsers(...args),
-  createUser: (...args) => mockCreateUser(...args)
-}));
-
-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);
-    });
-  });
-<%_ 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');
-    });
-  });
-<%_ } -%>
-});
+const { userResolvers } = require('@/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('@/controllers/userController', () => ({
+  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/mvc/js/src/graphql/typeDefs/user.types.js.ejs

@@ -1,17 +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
-  }
-`;
-
-module.exports = { userTypes };
+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/mvc/js/src/index.js.ejs

@@ -6,7 +6,7 @@ const healthRoutes = require('./routes/healthRoute');
 <%_ if (communication === 'Kafka') { -%>const { connectKafka, sendMessage } = require('./services/kafkaService');<%_ } -%>
 <%_ if (communication === 'GraphQL') { -%>
 const { ApolloServer } = require('@apollo/server');
-const { expressMiddleware } = require('@apollo/server/express4');
+const { expressMiddleware } = require('@as-integrations/express4');
 const { ApolloServerPluginLandingPageLocalDefault } = require('@apollo/server/plugin/landingPage/default');
 const { unwrapResolverError } = require('@apollo/server/errors');
 const { ApiError } = require('./errors/ApiError');

package/templates/mvc/js/src/routes/api.js

@@ -1,8 +1,10 @@
-const express = require('express');
-const router = express.Router();
-const userController = require('../controllers/userController');
-
-router.get('/users', userController.getUsers);
-router.post('/users', userController.createUser);
-
-module.exports = router;
+const express = require('express');
+const router = express.Router();
+const userController = require('../controllers/userController');
+
+router.get('/users', userController.getUsers);
+router.post('/users', userController.createUser);
+router.patch('/users/:id', userController.updateUser);
+router.delete('/users/:id', userController.deleteUser);
+
+module.exports = router;

package/templates/mvc/js/src/routes/api.spec.js.ejs

@@ -1,36 +1,41 @@
-const request = require('supertest');
-const express = require('express');
-const router = require('@/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('@/controllers/userController', () => ({
-  getUsers: (...args) => mockGetUsers(...args),
-  createUser: (...args) => mockCreateUser(...args)
-}));
-
-describe('ApiRoutes', () => {
-    let app;
-
-    beforeEach(() => {
-        app = express();
-        app.use(express.json());
-        app.use('/api', router);
-    });
-
-    it('GET /api/users should call controller.getUsers', async () => {
-        await request(app)
-            .get('/api/users');
-
-        expect(mockGetUsers).toHaveBeenCalledTimes(1);
-    });
-
-    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);
-    });
-});
+const request = require('supertest');
+const express = require('express');
+const router = require('@/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' }));
+
+const mockUpdateUser = jest.fn().mockImplementation((req, res) => res.status(200).json({ id: '1', name: 'Updated' }));
+const mockDeleteUser = jest.fn().mockImplementation((req, res) => res.status(200).json({ message: 'User deleted successfully' }));
+
+jest.mock('@/controllers/userController', () => ({
+  getUsers: (...args) => mockGetUsers(...args),
+  createUser: (...args) => mockCreateUser(...args),
+  updateUser: (...args) => mockUpdateUser(...args),
+  deleteUser: (...args) => mockDeleteUser(...args)
+}));
+
+describe('ApiRoutes', () => {
+    let app;
+
+    beforeEach(() => {
+        app = express();
+        app.use(express.json());
+        app.use('/api', router);
+    });
+
+    it('GET /api/users should call controller.getUsers', async () => {
+        await request(app)
+            .get('/api/users');
+
+        expect(mockGetUsers).toHaveBeenCalledTimes(1);
+    });
+
+    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);
+    });
+});

package/templates/mvc/js/src/utils/errorMessages.js

@@ -0,0 +1,14 @@
+const ERROR_MESSAGES = {
+    USER_NOT_FOUND: 'User not found',
+    RESOURCE_NOT_FOUND: 'Resource not found',
+    INVALID_USER_DATA: 'Invalid user event data',
+    INTERNAL_SERVER_ERROR: 'Internal Server Error',
+    BAD_REQUEST: 'Bad Request',
+    FETCH_USERS_ERROR: 'Error fetching users',
+    CREATE_USER_ERROR: 'Error creating user',
+    UPDATE_USER_ERROR: 'Error updating user',
+    DELETE_USER_ERROR: 'Error deleting user',
+    DATABASE_PING_FAILED: 'Health Check Database Ping Failed',
+};
+
+module.exports = ERROR_MESSAGES;