nodejs-quickstart-structure 1.18.1 → 1.19.1

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

@@ -1,84 +1,173 @@
-<% if (communication !== 'GraphQL') { -%>
-import { Request, Response, NextFunction } from 'express';
-import { HTTP_STATUS } from '@/utils/httpCodes';
-<% } -%>
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-import CreateUser from '@/usecases/createUser';
-import GetAllUsers from '@/usecases/getAllUsers';
-import logger from '@/infrastructure/log/logger';
-<%_ if (communication === 'Kafka') { -%>
-import { kafkaService } from '@/infrastructure/messaging/kafkaClient';
-<%_ } -%>
-
-export class UserController {
-    private createUserUseCase: CreateUser;
-    private getAllUsersUseCase: GetAllUsers;
-
-    constructor() {
-        const userRepository = new UserRepository();
-        this.createUserUseCase = new CreateUser(userRepository);
-        this.getAllUsersUseCase = new GetAllUsers(userRepository);
-    }
-
-<% if (communication === 'GraphQL') { -%>
-    async createUser(data: { name: string, email: string }) {
-        try {
-            const { name, email } = data;
-            const user = await this.createUserUseCase.execute(name, email);
-<%_ if (communication === 'Kafka') { -%>
-            await kafkaService.sendMessage('user-topic', JSON.stringify({
-                action: 'USER_CREATED',
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                payload: { id: (user as any).id || (user as any)._id, email: user.email }
-            }));
-<%_ } -%>
-            return user;
-        } catch (error: unknown) {
-            const message = error instanceof Error ? error.message : 'Unknown error';
-            logger.error('UserController CreateUser Error:', message);
-            throw error;
-        }
-    }
-
-    async getUsers() {
-        try {
-            const users = await this.getAllUsersUseCase.execute();
-            return users;
-        } catch (error: unknown) {
-            const message = error instanceof Error ? error.message : 'Unknown error';
-            logger.error('UserController GetUsers Error:', message);
-            throw error;
-        }
-    }
-<% } else { -%>
-    async createUser(req: Request, res: Response, next: NextFunction) {
-        try {
-            const { name, email } = req.body;
-            const user = await this.createUserUseCase.execute(name, email);
-<%_ if (communication === 'Kafka') { -%>
-            await kafkaService.sendMessage('user-topic', JSON.stringify({
-                action: 'USER_CREATED',
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                payload: { id: (user as any).id || (user as any)._id, email: user.email }
-            }));
-<%_ } -%>
-            res.status(HTTP_STATUS.CREATED).json(user);
-        } catch (error: unknown) {
-            const message = error instanceof Error ? error.message : 'Unknown error';
-            logger.error('UserController CreateUser Error:', message);
-            next(error);
-        }
-    }
-
-    async getUsers(req: Request, res: Response, next: NextFunction) {
-        try {
-            const users = await this.getAllUsersUseCase.execute();
-            res.json(users);
-        } catch (error: unknown) {
-            const message = error instanceof Error ? error.message : 'Unknown error';
-            logger.error('UserController GetUsers Error:', message);
-            next(error);
-        }
-    }
-<% } -%>
-}
+import { ERROR_MESSAGES } from '@/utils/errorMessages';
+<% if (communication !== 'GraphQL') { -%>
+import { Request, Response, NextFunction } from 'express';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+<% } -%>
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+import CreateUser from '@/usecases/createUser';
+import GetAllUsers from '@/usecases/getAllUsers';
+import UpdateUser from '@/usecases/updateUser';
+import DeleteUser from '@/usecases/deleteUser';
+import logger from '@/infrastructure/log/logger';
+<%_ if (communication === 'Kafka') { -%>
+import { kafkaService } from '@/infrastructure/messaging/kafkaClient';
+import { KAFKA_ACTIONS } from '@/utils/kafkaEvents';
+<%_ } -%>
+
+export class UserController {
+    private createUserUseCase: CreateUser;
+    private getAllUsersUseCase: GetAllUsers;
+    private updateUserUseCase: UpdateUser;
+    private deleteUserUseCase: DeleteUser;
+
+    constructor() {
+        const userRepository = new UserRepository();
+        this.createUserUseCase = new CreateUser(userRepository);
+        this.getAllUsersUseCase = new GetAllUsers(userRepository);
+        this.updateUserUseCase = new UpdateUser(userRepository);
+        this.deleteUserUseCase = new DeleteUser(userRepository);
+    }
+
+<% if (communication === 'GraphQL') { -%>
+    async createUser(data: { name: string, email: string }) {
+        try {
+            const { name, email } = data;
+            const user = await this.createUserUseCase.execute(name, email);
+<%_ if (communication === 'Kafka') { -%>
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const userId = (user as any).id || (user as any)._id;
+            await kafkaService.sendMessage('user-topic', JSON.stringify({
+                action: KAFKA_ACTIONS.USER_CREATED,
+                payload: { id: userId, email: user.email }
+            }), userId?.toString() || '');
+<%_ } -%>
+            return user;
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.CREATE_USER_ERROR}:`, message);
+            throw error;
+        }
+    }
+
+    async getUsers() {
+        try {
+            const users = await this.getAllUsersUseCase.execute();
+            return users;
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.FETCH_USERS_ERROR}:`, message);
+            throw error;
+        }
+    }
+
+    async updateUser(id: string, data: { name?: string, email?: string }) {
+        try {
+            const user = await this.updateUserUseCase.execute(id, data);
+            if (!user) throw new Error(ERROR_MESSAGES.USER_NOT_FOUND);
+<%_ if (communication === 'Kafka') { -%>
+            await kafkaService.sendMessage('user-topic', JSON.stringify({
+                action: KAFKA_ACTIONS.USER_UPDATED,
+                payload: { id, email: user.email }
+            }), id);
+<%_ } -%>
+            return user;
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.UPDATE_USER_ERROR}:`, message);
+            throw error;
+        }
+    }
+
+    async deleteUser(id: string) {
+        try {
+            const deleted = await this.deleteUserUseCase.execute(id);
+            if (!deleted) throw new Error(ERROR_MESSAGES.USER_NOT_FOUND);
+<%_ if (communication === 'Kafka') { -%>
+            await kafkaService.sendMessage('user-topic', JSON.stringify({
+                action: KAFKA_ACTIONS.USER_DELETED,
+                payload: { id }
+            }), id);
+<%_ } -%>
+            return true;
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.DELETE_USER_ERROR}:`, message);
+            throw error;
+        }
+    }
+<% } else { -%>
+    async createUser(req: Request, res: Response, next: NextFunction) {
+        try {
+            const { name, email } = req.body || {};
+            const user = await this.createUserUseCase.execute(name, email);
+<%_ if (communication === 'Kafka') { -%>
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const userId = (user as any).id || (user as any)._id;
+            await kafkaService.sendMessage('user-topic', JSON.stringify({
+                action: KAFKA_ACTIONS.USER_CREATED,
+                payload: { id: userId, email: user.email }
+            }), userId?.toString() || '');
+<%_ } -%>
+            res.status(HTTP_STATUS.CREATED).json(user);
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.CREATE_USER_ERROR}:`, message);
+            next(error);
+        }
+    }
+
+    async getUsers(req: Request, res: Response, next: NextFunction) {
+        try {
+            const users = await this.getAllUsersUseCase.execute();
+            res.json(users);
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.FETCH_USERS_ERROR}:`, message);
+            next(error);
+        }
+    }
+
+    async updateUser(req: Request, res: Response, next: NextFunction) {
+        try {
+            const { id } = req.params;
+            const { name, email } = req.body || {};
+            const user = await this.updateUserUseCase.execute(id, { name, email });
+            if (!user) {
+                return res.status(HTTP_STATUS.NOT_FOUND).json({ error: ERROR_MESSAGES.USER_NOT_FOUND });
+            }
+<%_ if (communication === 'Kafka') { -%>
+            await kafkaService.sendMessage('user-topic', JSON.stringify({
+                action: KAFKA_ACTIONS.USER_UPDATED,
+                payload: { id, email: user.email }
+            }), id);
+<%_ } -%>
+            res.json(user);
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.UPDATE_USER_ERROR}:`, message);
+            next(error);
+        }
+    }
+
+    async deleteUser(req: Request, res: Response, next: NextFunction) {
+        try {
+            const { id } = req.params;
+            const deleted = await this.deleteUserUseCase.execute(id);
+            if (!deleted) {
+                return res.status(HTTP_STATUS.NOT_FOUND).json({ error: ERROR_MESSAGES.USER_NOT_FOUND });
+            }
+<%_ if (communication === 'Kafka') { -%>
+            await kafkaService.sendMessage('user-topic', JSON.stringify({
+                action: KAFKA_ACTIONS.USER_DELETED,
+                payload: { id }
+            }), id);
+<%_ } -%>
+            res.status(HTTP_STATUS.OK).json({ message: 'User deleted successfully' });
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            logger.error(`${ERROR_MESSAGES.DELETE_USER_ERROR}:`, message);
+            next(error);
+        }
+    }
+<% } -%>
+}

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

@@ -1,32 +1,32 @@
-import { gqlContext } from '@/interfaces/graphql/context';
-import { Request } from 'express';
-import { resolvers } from '@/interfaces/graphql/resolvers';
-import { typeDefs } from '@/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',
-      },
-    } as Request;
-
-    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: {},
-    } as Request;
-
-    const context = await gqlContext({ req: mockRequest });
-    expect(context.token).toBe('');
-  });
-});
+import { gqlContext } from '@/interfaces/graphql/context';
+import { Request } from 'express';
+import { resolvers } from '@/interfaces/graphql/resolvers';
+import { typeDefs } from '@/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',
+      },
+    } as Request;
+
+    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: {},
+    } as Request;
+
+    const context = await gqlContext({ req: mockRequest });
+    expect(context.token).toBe('');
+  });
+});

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

@@ -1,17 +1,17 @@
-import { Request } from 'express';
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-
-export interface MyContext {
-  token?: string;
-  userRepository: UserRepository;
-}
-
-export const gqlContext = async ({ req }: { req: Request }): Promise<MyContext> => {
-  const token = req.headers.authorization || '';
-  const userRepository = new UserRepository();
-  
-  return { 
-    token, 
-    userRepository 
-  };
-};
+import { Request } from 'express';
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+
+export interface MyContext {
+  token?: string;
+  userRepository: UserRepository;
+}
+
+export const gqlContext = async ({ req }: { req: Request }): Promise<MyContext> => {
+  const token = req.headers.authorization || '';
+  const userRepository = new UserRepository();
+  
+  return { 
+    token, 
+    userRepository 
+  };
+};

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

@@ -1,3 +1,3 @@
-export { typeDefs } from '@/interfaces/graphql/typeDefs';
-export { resolvers } from '@/interfaces/graphql/resolvers';
-export { gqlContext, MyContext } from '@/interfaces/graphql/context';
+export { typeDefs } from '@/interfaces/graphql/typeDefs';
+export { resolvers } from '@/interfaces/graphql/resolvers';
+export { gqlContext, MyContext } from '@/interfaces/graphql/context';

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

@@ -1,4 +1,4 @@
-import { mergeResolvers } from '@graphql-tools/merge';
-import { userResolvers } from '@/interfaces/graphql/resolvers/user.resolvers';
-
-export const resolvers = mergeResolvers([userResolvers]);
+import { mergeResolvers } from '@graphql-tools/merge';
+import { userResolvers } from '@/interfaces/graphql/resolvers/user.resolvers';
+
+export const resolvers = mergeResolvers([userResolvers]);

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

@@ -1,51 +1,68 @@
-import { userResolvers } from '@/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 {
-    UserController: jest.fn().mockImplementation(() => ({
-      getUsers: (...args: unknown[]) => mockGetUsers(...args),
-      createUser: (...args: unknown[]) => 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 as { id?: string; _id?: unknown });
-      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 as { id?: string; _id?: unknown });
-      expect(result).toBe('456');
-    });
-  });
-<%_ } -%>
-});
+import { userResolvers } from '@/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 {
+    UserController: jest.fn().mockImplementation(() => ({
+      getUsers: (...args: unknown[]) => mockGetUsers(...args),
+      createUser: (...args: unknown[]) => 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 as { id?: string; _id?: unknown });
+      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 as { id?: string; _id?: unknown });
+      expect(result).toBe('456');
+    });
+  });
+<%_ } -%>
+});

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

@@ -1,21 +1,29 @@
-import { UserController } from '@/interfaces/controllers/userController';
-
-const userController = new UserController();
-
-export const userResolvers = {
-  Query: {
-    getAllUsers: async () => {
-      const users = await userController.getUsers();
-      return users;
-    }
-  },
-  Mutation: {
-    createUser: async (_: unknown, { name, email }: { name: string, email: string }) => {
-      const user = await userController.createUser({ name, email });
-      return user;
-    }
-  }<%_ if (database === 'MongoDB') { -%>,
-  User: {
-    id: (parent: { id?: string; _id?: unknown }) => parent.id || parent._id
-  }<%_ } %>
-};
+import { UserController } from '@/interfaces/controllers/userController';
+
+const userController = new UserController();
+
+export const userResolvers = {
+  Query: {
+    getAllUsers: async () => {
+      const users = await userController.getUsers();
+      return users;
+    }
+  },
+  Mutation: {
+    createUser: async (_: unknown, { name, email }: { name: string, email: string }) => {
+      const user = await userController.createUser({ name, email });
+      return user;
+    },
+    updateUser: async (_: unknown, { id, name, email }: { id: string, name?: string, email?: string }) => {
+      const user = await userController.updateUser(id, { name, email });
+      return user;
+    },
+    deleteUser: async (_: unknown, { id }: { id: string }) => {
+      const result = await userController.deleteUser(id);
+      return result;
+    }
+  }<%_ if (database === 'MongoDB') { -%>,
+  User: {
+    id: (parent: { id?: string; _id?: unknown }) => parent.id || parent._id
+  }<%_ } %>
+};

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

@@ -1,4 +1,4 @@
-import { mergeTypeDefs } from '@graphql-tools/merge';
-import { userTypes } from './user.types';
-
-export const typeDefs = mergeTypeDefs([userTypes]);
+import { mergeTypeDefs } from '@graphql-tools/merge';
+import { userTypes } from './user.types';
+
+export const typeDefs = mergeTypeDefs([userTypes]);

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

@@ -1,15 +1,17 @@
-export const userTypes = `#graphql
-  type User {
-    id: ID!
-    name: String!
-    email: String!
-  }
-
-  type Query {
-    getAllUsers: [User]
-  }
-
-  type Mutation {
-    createUser(name: String!, email: String!): User
-  }
-`;
+export 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
+  }
+`;