nodejs-quickstart-structure 1.18.1 → 1.19.1

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

@@ -1,14 +1,14 @@
-class ApiError extends Error {
-  constructor(statusCode, message, isOperational = true, stack = '') {
-    super(message);
-    this.statusCode = statusCode;
-    this.isOperational = isOperational;
-    if (stack) {
-      this.stack = stack;
-    } else {
-      Error.captureStackTrace(this, this.constructor);
-    }
-  }
-}
-
-module.exports = { ApiError };
+class ApiError extends Error {
+  constructor(statusCode, message, isOperational = true, stack = '') {
+    super(message);
+    this.statusCode = statusCode;
+    this.isOperational = isOperational;
+    if (stack) {
+      this.stack = stack;
+    } else {
+      Error.captureStackTrace(this, this.constructor);
+    }
+  }
+}
+
+module.exports = { ApiError };

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/context.js.ejs

@@ -1,7 +1,7 @@
-const gqlContext = async ({ req }) => {
-  // Setup authorization or context here
-  const token = req.headers.authorization || '';
-  return { token };
-};
-
-module.exports = { gqlContext };
+const gqlContext = async ({ req }) => {
+  // Setup authorization or context here
+  const token = req.headers.authorization || '';
+  return { token };
+};
+
+module.exports = { gqlContext };

package/templates/mvc/js/src/graphql/context.spec.js.ejs

@@ -1,29 +1,29 @@
-const { gqlContext } = require('@/graphql/context');
-const { resolvers } = require('@/graphql/resolvers');
-const { typeDefs } = require('@/graphql/typeDefs');
-
-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).toEqual({ token: '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).toEqual({ token: '' });
-  });
-});
+const { gqlContext } = require('@/graphql/context');
+const { resolvers } = require('@/graphql/resolvers');
+const { typeDefs } = require('@/graphql/typeDefs');
+
+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).toEqual({ token: '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).toEqual({ token: '' });
+  });
+});

package/templates/mvc/js/src/graphql/index.js.ejs

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

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

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

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/index.js.ejs

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

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 };