nodejs-quickstart-structure 1.9.2 → 1.10.0

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

@@ -0,0 +1,27 @@
+import { GraphQLError } from 'graphql';
+import { UserController } from '@/controllers/userController';
+
+const userController = new UserController();
+
+export const userResolvers = {
+  Query: {
+    getAllUsers: async () => {
+      try {
+        return await userController.getUsers();
+      } catch (error: unknown) {
+        const message = error instanceof Error ? error.message : 'Internal server error';
+        throw new GraphQLError(message, { extensions: { code: 'INTERNAL_SERVER_ERROR' } });
+      }
+    }
+  },
+  Mutation: {
+    createUser: async (_: unknown, { name, email }: { name: string, email: string }) => {
+      try {
+        return await userController.createUser({ name, email });
+      } catch (error: unknown) {
+        const message = error instanceof Error ? error.message : 'Internal server error';
+        throw new GraphQLError(message, { extensions: { code: 'INTERNAL_SERVER_ERROR' } });
+      }
+    }
+  }
+};

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

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

package/templates/mvc/ts/src/graphql/typeDefs/user.types.ts.ejs

@@ -0,0 +1,15 @@
+export const userTypes = `#graphql
+  type User {
+    id: ID!
+    name: String!
+    email: String!
+  }
+
+  type Query {
+    getAllUsers: [User]
+  }
+
+  type Mutation {
+    createUser(name: String!, email: String!): User
+  }
+`;

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

@@ -6,11 +6,19 @@ import rateLimit from 'express-rate-limit';
 import dotenv from 'dotenv';
 import logger from '@/utils/logger';
 import morgan from 'morgan';
-<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>import apiRoutes from '@/routes/api';<% } -%>
+<%_ if (communication === 'REST APIs') { -%>
+import apiRoutes from '@/routes/api';<%_ } -%>
 <% if (communication === 'REST APIs') { %>
 import swaggerUi from 'swagger-ui-express';
 import swaggerSpecs from '@/config/swagger';<% } -%>
-<% if (communication === 'Kafka') { %>import { KafkaService } from '@/services/kafkaService';<% } -%>
+<%_ if (communication === 'Kafka') { -%>import { KafkaService } from '@/services/kafkaService';<%_ } -%>
+<%_ if (communication === 'GraphQL') { -%>
+import { ApolloServer } from '@apollo/server';
+import { expressMiddleware } from '@apollo/server/express4';
+import { ApolloServerPluginLandingPageLocalDefault } from '@apollo/server/plugin/landingPage/default';
+import { typeDefs, resolvers } from '@/graphql';
+import { gqlContext, MyContext } from '@/graphql/context';
+<% } -%>
 
 dotenv.config();
 
@@ -18,7 +26,21 @@ const app = express();
 const port = process.env.PORT || 3000;
 
 // Security Middleware
+<%_ if (communication === 'GraphQL') { -%>
+app.use(helmet({
+  crossOriginEmbedderPolicy: false,
+  contentSecurityPolicy: {
+    directives: {
+      imgSrc: [`'self'`, 'data:', 'apollo-server-landing-page.cdn.apollographql.com'],
+      scriptSrc: [`'self'`, `https: 'unsafe-inline'`],
+      manifestSrc: [`'self'`, 'apollo-server-landing-page.cdn.apollographql.com'],
+      frameSrc: [`'self'`, 'sandbox.embed.apollographql.com'],
+    },
+  },
+}));
+<%_ } else { -%>
 app.use(helmet());
+<%_ } -%>
 app.use(hpp());
 app.use(cors({ origin: '*', methods: ['GET', 'POST', 'PUT', 'DELETE'] }));
 const limiter = rateLimit({ windowMs: 10 * 60 * 1000, max: 100 });
@@ -26,23 +48,18 @@ app.use(limiter);
 
 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
 import path from '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: Request, res: Response) => {
   res.render('index', { 
     projectName: 'NodeJS Service',
@@ -52,25 +69,36 @@ app.get('/', (req: Request, res: Response) => {
   });
 });
 <% } -%>
-
 app.get('/health', (req: Request, res: Response) => {
   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<MyContext>({
+      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 {
-      const kafkaService = new KafkaService();
-      await kafkaService.connect();
-      logger.info('Kafka connected');
-      // Demo: Send a test message
-      await kafkaService.sendMessage('test-topic', 'Hello Kafka from MVC TS!');
-    } catch (err) {
-      logger.error('Failed to connect to Kafka:', err);
-    }
+        try {
+          const kafkaService = new KafkaService();
+          kafkaService.connect().then(() => {
+            logger.info('Kafka connected');
+            kafkaService.sendMessage('test-topic', 'Hello Kafka from MVC TS!');
+          });
+        } catch (err) {
+          logger.error('Failed to connect to Kafka:', err);
+        }
 <%_ } -%>
+    });
 };
 
 <%_ if (database !== 'None') { -%>
@@ -88,7 +116,7 @@ const syncDatabase = async () => {
             <%_ } -%>
             logger.info('Database synced');
             // Start Server after DB is ready
-            app.listen(port, startServer);
+            await startServer();
             break;
         } catch (error) {
             logger.error('Error syncing database:', error);
@@ -101,5 +129,5 @@ const syncDatabase = async () => {
 
 syncDatabase();
 <%_ } else { -%>
-app.listen(port, startServer);
+startServer();
 <%_ } -%>

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

@@ -4,72 +4,6 @@ import { UserController } from '@/controllers/userController';
 const router = Router();
 const userController = new 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', (req: Request, res: Response) => userController.getUsers(req, res));
 router.post('/users', (req: Request, res: Response) => userController.createUser(req, res));