nodejs-quickstart-structure 1.9.2 → 1.10.0

package/templates/common/README.md.ejs

@@ -84,6 +84,33 @@ npm run format
 The project follows **<%= architecture %>** principles.
 <% if (communication === 'Kafka') { -%>
 Microservices communication handled via **Kafka**.
+<% } else if (communication === 'GraphQL') { -%>
+API is exposed via **GraphQL**.
+The Apollo Sandbox UI for API exploration and documentation is available natively, fully embedded for offline development:
+- **URL**: `http://localhost:3000/graphql` (Dynamic based on PORT)
+If you are opening `http://localhost:3000/graphql` in your browser, you can directly run the following in the Apollo Sandbox UI:
+
+**Query to get all users:**
+```graphql
+query GetAllUsers {
+  getAllUsers {
+    id
+    name
+    email
+  }
+}
+```
+
+**Mutation to create a user:**
+```graphql
+mutation CreateUser {
+  createUser(name: "John Doe", email: "john@example.com") {
+    id
+    name
+    email
+  }
+}
+```
 <% } else { -%>
 API is exposed via **REST**.
 A Swagger UI for API documentation is available at:

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

@@ -6,7 +6,6 @@ logger = require('../utils/logger');
 <% } else { %>
 logger = require('../log/logger');
 <% } %>
-
 const connectDB = async () => {
     const dbHost = process.env.DB_HOST || 'localhost';
     const mongoURI = process.env.MONGO_URI || `mongodb://${dbHost}:27017/<%= dbName %>`;

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

@@ -4,7 +4,6 @@ import logger from '@/utils/logger';
 <% } else { %>
 import logger from '@/infrastructure/log/logger';
 <% } %>
-
 const connectDB = async (): Promise<void> => {
     const dbHost = process.env.DB_HOST || 'localhost';
     const mongoURI = process.env.MONGO_URI || `mongodb://${dbHost}:27017/<%= dbName %>`;

package/templates/common/package.json.ejs

@@ -6,7 +6,7 @@
   "scripts": {
     "start": "<% if (language === 'TypeScript') { %>node dist/index.js<% } else { %>node src/index.js<% } %>",
     "dev": "<% if (language === 'TypeScript') { %>nodemon --exec ts-node -r tsconfig-paths/register src/index.ts<% } else { %>nodemon src/index.js<% } %>"<% if (language === 'TypeScript') { %>,
-    "build": "rimraf dist && tsc && tsc-alias<% if (viewEngine && viewEngine !== 'None') { %> && cpx \"src/views/**/*\" dist/views<% } %>"<% } %>,
+    "build": "rimraf dist && tsc && tsc-alias<% if (viewEngine && viewEngine !== 'None') { %> && cpx \"src/views/**/*\" dist/views<% } %><% if (communication === 'REST APIs') { %> && cpx \"src/**/*.yml\" dist/<% } %>"<% } %>,
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --write .",
@@ -48,7 +48,10 @@
     "winston-daily-rotate-file": "^5.0.0",
     "morgan": "^1.10.0"<% if (communication === 'REST APIs') { %>,
     "swagger-ui-express": "^5.0.0",
-    "swagger-jsdoc": "^6.2.8"<% } %>
+    "yamljs": "^0.3.0"<% } %><% if (communication === 'GraphQL') { %>,
+    "@apollo/server": "^4.10.0",
+    "graphql": "^16.8.1",
+    "@graphql-tools/merge": "^9.0.3"<% } %>
   },
   "devDependencies": {
     "nodemon": "^3.0.2"<% if (language === 'TypeScript') { %>,
@@ -68,7 +71,7 @@
     "@types/sequelize": "^4.28.19",
 <%_ } -%>
     "@types/morgan": "^1.9.9",
-    "rimraf": "^6.0.1"<% if (viewEngine && viewEngine !== 'None') { %>,
+    "rimraf": "^6.0.1"<% if ((viewEngine && viewEngine !== 'None') || communication === 'REST APIs') { %>,
     "cpx2": "^8.0.0"<% } %><% } %>,
     "eslint": "^9.20.1",
     "@eslint/js": "^9.20.0",
@@ -79,7 +82,7 @@
     "lint-staged": "^15.4.3"<% if (language === 'TypeScript') { %>,
     "typescript-eslint": "^8.24.1",
 <% if (communication === 'REST APIs') { %>    "@types/swagger-ui-express": "^4.1.6",
-    "@types/swagger-jsdoc": "^6.0.4",<% } -%>
+    "@types/yamljs": "^0.2.34",<% } %>
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "@types/jest": "^29.5.14",

package/templates/common/swagger.yml.ejs

@@ -0,0 +1,66 @@
+openapi: 3.0.0
+info:
+  title: <%= projectName %> API
+  version: 1.0.0
+  description: API documentation for <%= projectName %>
+servers:
+  - url: http://localhost:3000
+    description: Local Server
+components:
+  schemas:
+    User:
+      type: object
+      required:
+        - name
+        - email
+      properties:
+        id:
+          type: integer
+          description: The auto-generated id of the user
+        name:
+          type: string
+          description: The name of the user
+        email:
+          type: string
+          description: The email of the user
+      example:
+        id: 1
+        name: John Doe
+        email: john@example.com
+tags:
+  - name: Users
+    description: The users managing API
+paths:
+  /api/users:
+    get:
+      summary: Returns the list of all the users
+      tags:
+        - Users
+      responses:
+        '200':
+          description: The list of the users
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/User'
+    post:
+      summary: Create a new user
+      tags:
+        - Users
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/User'
+      responses:
+        '201':
+          description: The created user.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        '500':
+          description: Some server error

package/templates/mvc/js/src/config/swagger.js

@@ -1,23 +1,6 @@
-const swaggerJsdoc = require('swagger-jsdoc');
+const path = require('path');
+const YAML = require('yamljs');
 
-const options = {
-  definition: {
-    openapi: '3.0.0',
-    info: {
-      title: 'NodeJS API Service',
-      version: '1.0.0',
-      description: 'API documentation for the NodeJS Service',
-    },
-    servers: [
-      {
-        url: process.env.SERVER_URL || `http://localhost:${process.env.PORT || 3000}`,
-        description: 'Server',
-      },
-    ],
-  },
-  apis: ['./src/routes/*.js'], // Path to the API docs
-};
+const swaggerDocument = YAML.load(path.join(__dirname, 'swagger.yml'));
 
-const specs = swaggerJsdoc(options);
-
-module.exports = specs;
+module.exports = swaggerDocument;

package/templates/mvc/js/src/controllers/userController.js.ejs

@@ -1,5 +1,7 @@
 const User = require('../models/User');
+<% if (communication !== 'GraphQL') { -%>
 const HTTP_STATUS = require('../utils/httpCodes');
+<% } -%>
 const logger = require('../utils/logger');
 <%_ if (caching === 'Redis') { -%>
 const cacheService = require('../config/redisClient');
@@ -7,6 +9,58 @@ const cacheService = require('../config/redisClient');
 const cacheService = require('../config/memoryCache');
 <%_ } -%>
 
+<% if (communication === 'GraphQL') { -%>
+const getUsers = async () => {
+  try {
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+    const users = await cacheService.getOrSet('users:all', async () => {
+<%_ if (database === 'MongoDB') { -%>
+        return await User.find();
+<%_ } else if (database === 'None') { -%>
+        return User.mockData;
+<%_ } else { -%>
+        return await User.findAll();
+<%_ } -%>
+    }, 60);
+<%_ } else { -%>
+<%_ if (database === 'MongoDB') { -%>
+    const users = await User.find();
+<%_ } else if (database === 'None') { -%>
+    const users = User.mockData;
+<%_ } else { -%>
+    const users = await User.findAll();
+<%_ } -%>
+<%_ } -%>
+    return users;
+  } catch (error) {
+    logger.error('Error fetching users:', error);
+    throw error;
+  }
+};
+
+const createUser = async (data) => {
+  try {
+    const { name, email } = data;
+<%_ if (database === 'None') { -%>
+    const newUser = { id: String(User.mockData.length + 1), name, email };
+    User.mockData.push(newUser);
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+    await cacheService.del('users:all');
+<%_ } -%>
+    return newUser;
+<%_ } else { -%>
+    const user = await User.create({ name, email });
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+    await cacheService.del('users:all');
+<%_ } -%>
+    return user;
+<%_ } -%>
+  } catch (error) {
+    logger.error('Error creating user:', error);
+    throw error;
+  }
+};
+<% } else { -%>
 const getUsers = async (req, res) => {
   try {
 <%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
@@ -56,6 +110,7 @@ const createUser = async (req, res) => {
     res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: error.message });
   }
 };
+<% } -%>
 
 module.exports = { getUsers, createUser };
 

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

@@ -0,0 +1,7 @@
+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/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/mvc/js/src/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/mvc/js/src/graphql/resolvers/user.resolvers.js.ejs

@@ -0,0 +1,25 @@
+const { GraphQLError } = require('graphql');
+const userController = require('../../controllers/userController');
+
+const userResolvers = {
+  Query: {
+    getAllUsers: async () => {
+      try {
+        return await userController.getUsers();
+      } catch (error) {
+        throw new GraphQLError(error.message || 'Internal server error', { extensions: { code: 'INTERNAL_SERVER_ERROR' } });
+      }
+    }
+  },
+  Mutation: {
+    createUser: async (_, { name, email }) => {
+      try {
+        return await userController.createUser({ name, email });
+      } catch (error) {
+        throw new GraphQLError(error.message || 'Internal server error', { extensions: { code: 'INTERNAL_SERVER_ERROR' } });
+      }
+    }
+  }
+};
+
+module.exports = { userResolvers };

package/templates/mvc/js/src/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/mvc/js/src/graphql/typeDefs/user.types.js.ejs

@@ -0,0 +1,17 @@
+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 };

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

@@ -1,12 +1,19 @@
 const express = require('express');
 const cors = require('cors');
 require('dotenv').config();
-<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>const apiRoutes = require('./routes/api');<% } -%>
-<% if (communication === 'Kafka') { %>const { connectKafka, sendMessage } = require('./services/kafkaService');<% } -%>
-<% if (communication === 'REST APIs') { -%>
+<%_ if (communication === 'REST APIs') { -%>const apiRoutes = require('./routes/api');<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>const { connectKafka, sendMessage } = require('./services/kafkaService');<%_ } -%>
+<%_ if (communication === 'GraphQL') { -%>
+const { ApolloServer } = require('@apollo/server');
+const { expressMiddleware } = require('@apollo/server/express4');
+const { ApolloServerPluginLandingPageLocalDefault } = require('@apollo/server/plugin/landingPage/default');
+const { typeDefs, resolvers } = require('./graphql');
+const { gqlContext } = require('./graphql/context');
+<% } -%>
+<%_ if (communication === 'REST APIs') { -%>
 const swaggerUi = require('swagger-ui-express');
 const swaggerSpecs = require('./config/swagger');
-<% } -%>
+<%_ } -%>
 
 const app = express();
 const PORT = process.env.PORT || 3000;
@@ -17,22 +24,18 @@ app.use(cors());
 app.use(express.json());
 app.use(morgan('combined', { stream: { write: message => logger.info(message.trim()) } }));
 
-<% if (communication === 'REST APIs') { -%>
+<%_ if (communication === 'REST APIs') { -%>
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
-<% } -%>
-
-<% if (viewEngine === 'EJS' || viewEngine === 'Pug') { -%>
+<%_ } -%>
+<%_ if (viewEngine === 'EJS' || viewEngine === 'Pug') { -%>
 // View Engine Setup
 const path = require('path');
 app.set('views', path.join(__dirname, 'views'));
 app.set('view engine', '<%= viewEngine.toLowerCase() %>');
-app.use(express.static(path.join(__dirname, '../public')));<% } -%>
-
-// Routes
-<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { -%>
+app.use(express.static(path.join(__dirname, '../public')));<%_ } %>
+<%_ if (communication === 'REST APIs') { -%>
 app.use('/api', apiRoutes);
-<% } -%>
-<% if (viewEngine && viewEngine !== 'None') { -%>
+<%_ } -%><% if (viewEngine && viewEngine !== 'None') { -%>
 app.get('/', (req, res) => {
   res.render('index', { 
     projectName: 'NodeJS Service',
@@ -42,24 +45,33 @@ app.get('/', (req, res) => {
   });
 });
 <% } -%>
-
 app.get('/health', (req, res) => {
   res.json({ status: 'UP' });
 });
 
 // Start Server Logic
 const startServer = async () => {
-    logger.info(`Server running on port ${PORT}`);
+<%_ if (communication === 'GraphQL') { -%>
+    // GraphQL Setup
+    const server = new ApolloServer({
+      typeDefs,
+      resolvers,
+      plugins: [ApolloServerPluginLandingPageLocalDefault({ embed: true })],
+    });
+    await server.start();
+    app.use('/graphql', expressMiddleware(server, { context: gqlContext }));
+<%_ } -%>
+    app.listen(PORT, () => {
+        logger.info(`Server running on port ${PORT}`);
 <%_ if (communication === 'Kafka') { -%>
-    try {
-      await connectKafka();
-      logger.info('Kafka connected');
-      // Demo: Send a test message
-      await sendMessage('test-topic', 'Hello Kafka from MVC JS!');
-    } catch (err) {
-      logger.error('Failed to connect to Kafka:', err);
-    }
+        connectKafka().then(() => {
+          logger.info('Kafka connected');
+          sendMessage('test-topic', 'Hello Kafka from MVC JS!');
+        }).catch(err => {
+          logger.error('Failed to connect to Kafka:', err);
+        });
 <%_ } -%>
+    });
 };
 
 <%_ if (database !== 'None') { -%>
@@ -78,7 +90,7 @@ const syncDatabase = async () => {
             logger.info('Database synced');
             
             // Start Server after DB is ready
-            app.listen(PORT, startServer);
+            await startServer();
             break;
         } catch (err) {
             logger.error('Database sync failed:', err);
@@ -91,5 +103,5 @@ const syncDatabase = async () => {
 
 syncDatabase();
 <%_ } else { -%>
-app.listen(PORT, startServer);
+startServer();
 <%_ } -%>

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

@@ -2,72 +2,6 @@ const express = require('express');
 const router = express.Router();
 const userController = require('../controllers/userController');
 
-/**
- * @swagger
- * components:
- *   schemas:
- *     User:
- *       type: object
- *       required:
- *         - name
- *         - email
- *       properties:
- *         id:
- *           type: integer
- *           description: The auto-generated id of the user
- *         name:
- *           type: string
- *           description: The name of the user
- *         email:
- *           type: string
- *           description: The email of the user
- *       example:
- *         id: 1
- *         name: John Doe
- *         email: john@example.com
- */
-
-/**
- * @swagger
- * tags:
- *   name: Users
- *   description: The users managing API
- */
-
-/**
- * @swagger
- * /api/users:
- *   get:
- *     summary: Returns the list of all the users
- *     tags: [Users]
- *     responses:
- *       200:
- *         description: The list of the users
- *         content:
- *           application/json:
- *             schema:
- *               type: array
- *               items:
- *                 $ref: '#/components/schemas/User'
- *   post:
- *     summary: Create a new user
- *     tags: [Users]
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/User'
- *     responses:
- *       201:
- *         description: The created user.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/User'
- *       500:
- *         description: Some server error
- */
 router.get('/users', userController.getUsers);
 router.post('/users', userController.createUser);
 

package/templates/mvc/ts/src/config/swagger.ts.ejs

@@ -1,23 +1,6 @@
-<% if (communication === 'REST APIs') { %>import swaggerJsdoc from 'swagger-jsdoc';
+<% if (communication === 'REST APIs') { %>import path from 'path';
+import YAML from 'yamljs';
 
-const options = {
-  definition: {
-    openapi: '3.0.0',
-    info: {
-      title: 'NodeJS API Service',
-      version: '1.0.0',
-      description: 'API documentation for the NodeJS Service',
-    },
-    servers: [
-      {
-        url: process.env.SERVER_URL || `http://localhost:${process.env.PORT || 3000}`,
-        description: 'Server',
-      },
-    ],
-  },
-  apis: ['./src/routes/*.ts', './dist/routes/*.js'], // Path to the API docs
-};
+const swaggerDocument = YAML.load(path.join(__dirname, 'swagger.yml'));
 
-const specs = swaggerJsdoc(options);
-
-export default specs;<% } %>
+export default swaggerDocument;<% } %>

package/templates/mvc/ts/src/controllers/userController.ts.ejs

@@ -1,6 +1,8 @@
+<% if (communication !== 'GraphQL') { -%>
 import { Request, Response } from 'express';
-import User from '@/models/User';
 import { HTTP_STATUS } from '@/utils/httpCodes';
+<% } -%>
+import User from '@/models/User';
 import logger from '@/utils/logger';
 <%_ if (caching === 'Redis') { -%>
 import cacheService from '@/config/redisClient';
@@ -9,6 +11,58 @@ import cacheService from '@/config/memoryCache';
 <%_ } -%>
 
 export class UserController {
+<% if (communication === 'GraphQL') { -%>
+    async getUsers() {
+        try {
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+            const users = await cacheService.getOrSet('users:all', async () => {
+<%_ if (database === 'MongoDB') { -%>
+                return await User.find();
+<%_ } else if (database === 'None') { -%>
+                return User.mockData;
+<%_ } else { -%>
+                return await User.findAll();
+<%_ } -%>
+            }, 60);
+<%_ } else { -%>
+<%_ if (database === 'MongoDB') { -%>
+            const users = await User.find();
+<%_ } else if (database === 'None') { -%>
+            const users = User.mockData;
+<%_ } else { -%>
+            const users = await User.findAll();
+<%_ } -%>
+<%_ } -%>
+            return users;
+        } catch (error) {
+            logger.error('Error fetching users:', error);
+            throw error;
+        }
+    }
+
+    async createUser(data: { name: string, email: string }) {
+        try {
+            const { name, email } = data;
+<%_ if (database === 'None') { -%>
+            const newUser = { id: String(User.mockData.length + 1), name, email };
+            User.mockData.push(newUser);
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+            await cacheService.del('users:all');
+<%_ } -%>
+            return newUser;
+<%_ } else { -%>
+            const user = await User.create({ name, email });
+<%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
+            await cacheService.del('users:all');
+<%_ } -%>
+            return user;
+<%_ } -%>
+        } catch (error) {
+            logger.error('Error creating user:', error);
+            throw error;
+        }
+    }
+<% } else { -%>
     async getUsers(req: Request, res: Response) {
         try {
 <%_ if (caching === 'Redis' || caching === 'Memory Cache') { -%>
@@ -67,5 +121,6 @@ export class UserController {
             }
         }
     }
+<% } -%>
 }
 

package/templates/mvc/ts/src/graphql/context.ts.ejs

@@ -0,0 +1,12 @@
+import { Request } from 'express';
+
+export interface MyContext {
+  token?: string;
+  // user?: User;
+}
+
+export const gqlContext = async ({ req }: { req: Request }): Promise<MyContext> => {
+  // Setup authorization or context here
+  const token = req.headers.authorization || '';
+  return { token };
+};

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

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

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

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