nodejs-quickstart-structure 1.19.0 → 2.0.0

package/templates/clean-architecture/js/src/infrastructure/log/logger.js

@@ -1,36 +1,36 @@
-const winston = require('winston');
-require('winston-daily-rotate-file');
-
-const logger = winston.createLogger({
-  level: 'info',
-  format: winston.format.combine(
-    winston.format.timestamp(),
-    winston.format.json()
-  ),
-  defaultMeta: { service: 'user-service' },
-  transports: [
-    new winston.transports.DailyRotateFile({
-      filename: 'logs/error-%DATE%.log',
-      datePattern: 'YYYY-MM-DD',
-      zippedArchive: true,
-      maxSize: '20m',
-      maxFiles: '14d',
-      level: 'error',
-    }),
-    new winston.transports.DailyRotateFile({
-      filename: 'logs/combined-%DATE%.log',
-      datePattern: 'YYYY-MM-DD',
-      zippedArchive: true,
-      maxSize: '20m',
-      maxFiles: '14d',
-    }),
-  ],
-});
-
-logger.add(new winston.transports.Console({
-  format: process.env.NODE_ENV !== 'production'
-    ? winston.format.simple()
-    : winston.format.json(),
-}));
-
-module.exports = logger;
+const winston = require('winston');
+require('winston-daily-rotate-file');
+
+const logger = winston.createLogger({
+  level: 'info',
+  format: winston.format.combine(
+    winston.format.timestamp(),
+    winston.format.json()
+  ),
+  defaultMeta: { service: 'user-service' },
+  transports: [
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/error-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+      level: 'error',
+    }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/combined-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+    }),
+  ],
+});
+
+logger.add(new winston.transports.Console({
+  format: process.env.NODE_ENV !== 'production'
+    ? winston.format.simple()
+    : winston.format.json(),
+}));
+
+module.exports = logger;

package/templates/clean-architecture/js/src/infrastructure/log/logger.spec.js.ejs

@@ -1,63 +1,63 @@
-jest.mock('winston-daily-rotate-file');
-jest.mock('winston', () => {
-    const mockLogger = {
-        add: jest.fn(),
-        info: jest.fn(),
-        error: jest.fn(),
-        warn: jest.fn()
-    };
-    const format = {
-        combine: jest.fn(),
-        timestamp: jest.fn(),
-        json: jest.fn(),
-        simple: jest.fn()
-    };
-    const transports = {
-        Console: jest.fn(),
-        DailyRotateFile: jest.fn()
-    };
-    return {
-        format,
-        transports,
-        createLogger: jest.fn().mockReturnValue(mockLogger)
-    };
-});
-
-<% if (architecture === 'MVC') { -%>
-const logger = require('@/utils/logger');
-<% } else { -%>
-const logger = require('@/infrastructure/log/logger');
-<% } -%>
-
-describe('Logger', () => {
-    it('should export a logger instance', () => {
-        expect(logger).toBeDefined();
-    });
-
-    it('should have info method', () => {
-        expect(typeof logger.info).toBe('function');
-    });
-
-    it('should have error method', () => {
-        expect(typeof logger.error).toBe('function');
-    });
-
-    it('should call info', () => {
-        logger.info('test message');
-        expect(logger.info).toHaveBeenCalledWith('test message');
-    });
-
-    it('should call error', () => {
-        logger.error('test error');
-        expect(logger.error).toHaveBeenCalledWith('test error');
-    });
-
-    it('should use JSON format in production environment', () => {
-        const winston = require('winston');
-        jest.resetModules();
-        process.env.NODE_ENV = 'production';
-        require('@/infrastructure/log/logger');
-        expect(winston.format.json).toHaveBeenCalled();
-        process.env.NODE_ENV = 'test';
-    });
-});
+jest.mock('winston-daily-rotate-file');
+jest.mock('winston', () => {
+    const mockLogger = {
+        add: jest.fn(),
+        info: jest.fn(),
+        error: jest.fn(),
+        warn: jest.fn()
+    };
+    const format = {
+        combine: jest.fn(),
+        timestamp: jest.fn(),
+        json: jest.fn(),
+        simple: jest.fn()
+    };
+    const transports = {
+        Console: jest.fn(),
+        DailyRotateFile: jest.fn()
+    };
+    return {
+        format,
+        transports,
+        createLogger: jest.fn().mockReturnValue(mockLogger)
+    };
+});
+
+<% if (architecture === 'MVC') { -%>
+const logger = require('@/utils/logger');
+<% } else { -%>
+const logger = require('@/infrastructure/log/logger');
+<% } -%>
+
+describe('Logger', () => {
+    it('should export a logger instance', () => {
+        expect(logger).toBeDefined();
+    });
+
+    it('should have info method', () => {
+        expect(typeof logger.info).toBe('function');
+    });
+
+    it('should have error method', () => {
+        expect(typeof logger.error).toBe('function');
+    });
+
+    it('should call info', () => {
+        logger.info('test message');
+        expect(logger.info).toHaveBeenCalledWith('test message');
+    });
+
+    it('should call error', () => {
+        logger.error('test error');
+        expect(logger.error).toHaveBeenCalledWith('test error');
+    });
+
+    it('should use JSON format in production environment', () => {
+        const winston = require('winston');
+        jest.resetModules();
+        process.env.NODE_ENV = 'production';
+        require('@/infrastructure/log/logger');
+        expect(winston.format.json).toHaveBeenCalled();
+        process.env.NODE_ENV = 'test';
+    });
+});

package/templates/clean-architecture/js/src/infrastructure/webserver/middleware/errorMiddleware.js

@@ -1,30 +1,30 @@
-const logger = require('../../log/logger');
-const { ApiError } = require('../../../errors/ApiError');
-const HTTP_STATUS = require('../../../utils/httpCodes');
-
-// eslint-disable-next-line no-unused-vars
-const errorMiddleware = (err, req, res, next) => {
-  let error = err;
-
-  if (!(error instanceof ApiError)) {
-    const statusCode = err.statusCode || HTTP_STATUS.INTERNAL_SERVER_ERROR;
-    const message = error.message || 'Internal Server Error';
-    error = new ApiError(statusCode, message, false, err.stack);
-  }
-
-  const { statusCode, message } = error;
-
-  if (statusCode === HTTP_STATUS.INTERNAL_SERVER_ERROR) {
-    logger.error(`${statusCode} - ${message} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
-    logger.error(error.stack || 'No stack trace');
-  }
-
-  res.status(statusCode).json({
-    statusCode,
-    message,
-    ...(process.env.NODE_ENV === 'development' && { stack: error.stack }),
-  });
-};
-
-module.exports = { errorMiddleware };
-
+const logger = require('../../log/logger');
+const { ApiError } = require('../../../errors/ApiError');
+const HTTP_STATUS = require('../../../utils/httpCodes');
+
+// eslint-disable-next-line no-unused-vars
+const errorMiddleware = (err, req, res, next) => {
+  let error = err;
+
+  if (!(error instanceof ApiError)) {
+    const statusCode = err.statusCode || HTTP_STATUS.INTERNAL_SERVER_ERROR;
+    const message = error.message || 'Internal Server Error';
+    error = new ApiError(statusCode, message, false, err.stack);
+  }
+
+  const { statusCode, message } = error;
+
+  if (statusCode === HTTP_STATUS.INTERNAL_SERVER_ERROR) {
+    logger.error(`${statusCode} - ${message} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
+    logger.error(error.stack || 'No stack trace');
+  }
+
+  res.status(statusCode).json({
+    statusCode,
+    message,
+    ...(process.env.NODE_ENV === 'development' && { stack: error.stack }),
+  });
+};
+
+module.exports = { errorMiddleware };
+

package/templates/clean-architecture/js/src/infrastructure/webserver/server.js.ejs

@@ -1,89 +1,89 @@
-const express = require('express');
-const cors = require('cors');
-const logger = require('../log/logger');
-const morgan = require('morgan');
-const { errorMiddleware } = require('./middleware/errorMiddleware');
-const healthRoutes = require('../../interfaces/routes/healthRoute');
-const setupGracefulShutdown = require('../../utils/gracefulShutdown');
-<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
-const apiRoutes = require('../../interfaces/routes/api');
-const swaggerUi = require('swagger-ui-express');
-const swaggerSpecs = require('./swagger');
-<%_ } -%>
-<%_ if (communication === 'GraphQL') { -%>
-const { ApolloServer } = require('@apollo/server');
-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');
-const { typeDefs, resolvers } = require('../../interfaces/graphql');
-const { gqlContext } = require('../../interfaces/graphql/context');
-<%_ } -%>
-
-const { env } = require('../config/env');
-
-const startServer = async () => {
-    // Determine port using the validated env
-    const port = env.PORT;
-    const app = express();
-
-    app.use(cors());
-    app.use(express.json());
-    app.use(morgan('combined', { stream: { write: message => logger.info(message.trim()) } }));
-    <%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
-    app.use('/api', apiRoutes);
-    <%_ } -%>
-    <%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
-    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
-    <%_ } -%>
-    <%_ if (communication === 'GraphQL') { -%>
-    // GraphQL Setup
-    const apolloServer = new ApolloServer({
-        typeDefs,
-        resolvers,
-        plugins: [ApolloServerPluginLandingPageLocalDefault({ embed: true })],
-        formatError: (formattedError, error) => {
-            const originalError = unwrapResolverError(error);
-            if (originalError instanceof ApiError) {
-              return {
-                ...formattedError,
-                message: originalError.message,
-                extensions: {
-                  ...formattedError.extensions,
-                  code: originalError.statusCode.toString(),
-                }
-              };
-            }
-            
-            logger.error(`GraphQL Error: ${formattedError.message}`);
-            if (originalError && originalError.stack && process.env.NODE_ENV === 'development') {
-               logger.error(originalError.stack);
-            }
-            return formattedError;
-        },
-    });
-    await apolloServer.start();
-    app.use('/graphql', expressMiddleware(apolloServer, { context: gqlContext }));
-    <%_ } -%>
-    app.use('/health', healthRoutes);
-
-    app.use(errorMiddleware);
-
-    const server = app.listen(port, () => {
-        logger.info(`Server running on port ${port}`);
-<%_ if (communication === 'Kafka') { -%>
-        const { connectKafka } = require('../../infrastructure/messaging/kafkaClient');
-        connectKafka()
-            .then(async () => {
-                logger.info('Kafka connected');
-            })
-            .catch(err => {
-                logger.error('Failed to connect to Kafka after retries:', err.message);
-            });
-<%_ } -%>
-    });
-
-    setupGracefulShutdown(server);
-};
-
-module.exports = startServer;
+const express = require('express');
+const cors = require('cors');
+const logger = require('../log/logger');
+const morgan = require('morgan');
+const { errorMiddleware } = require('./middleware/errorMiddleware');
+const healthRoutes = require('../../interfaces/routes/healthRoute');
+const setupGracefulShutdown = require('../../utils/gracefulShutdown');
+<%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
+const apiRoutes = require('../../interfaces/routes/api');
+const swaggerUi = require('swagger-ui-express');
+const swaggerSpecs = require('./swagger');
+<%_ } -%>
+<%_ if (communication === 'GraphQL') { -%>
+const { ApolloServer } = require('@apollo/server');
+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');
+const { typeDefs, resolvers } = require('../../interfaces/graphql');
+const { gqlContext } = require('../../interfaces/graphql/context');
+<%_ } -%>
+
+const { env } = require('../config/env');
+
+const startServer = async () => {
+    // Determine port using the validated env
+    const port = env.PORT;
+    const app = express();
+
+    app.use(cors());
+    app.use(express.json());
+    app.use(morgan('combined', { stream: { write: message => logger.info(message.trim()) } }));
+    <%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
+    app.use('/api', apiRoutes);
+    <%_ } -%>
+    <%_ if (communication === 'REST APIs' || communication === 'Kafka') { -%>
+    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
+    <%_ } -%>
+    <%_ if (communication === 'GraphQL') { -%>
+    // GraphQL Setup
+    const apolloServer = new ApolloServer({
+        typeDefs,
+        resolvers,
+        plugins: [ApolloServerPluginLandingPageLocalDefault({ embed: true })],
+        formatError: (formattedError, error) => {
+            const originalError = unwrapResolverError(error);
+            if (originalError instanceof ApiError) {
+              return {
+                ...formattedError,
+                message: originalError.message,
+                extensions: {
+                  ...formattedError.extensions,
+                  code: originalError.statusCode.toString(),
+                }
+              };
+            }
+            
+            logger.error(`GraphQL Error: ${formattedError.message}`);
+            if (originalError && originalError.stack && process.env.NODE_ENV === 'development') {
+               logger.error(originalError.stack);
+            }
+            return formattedError;
+        },
+    });
+    await apolloServer.start();
+    app.use('/graphql', expressMiddleware(apolloServer, { context: gqlContext }));
+    <%_ } -%>
+    app.use('/health', healthRoutes);
+
+    app.use(errorMiddleware);
+
+    const server = app.listen(port, () => {
+        logger.info(`Server running on port ${port}`);
+<%_ if (communication === 'Kafka') { -%>
+        const { connectKafka } = require('../../infrastructure/messaging/kafkaClient');
+        connectKafka()
+            .then(async () => {
+                logger.info('Kafka connected');
+            })
+            .catch(err => {
+                logger.error('Failed to connect to Kafka after retries:', err.message);
+            });
+<%_ } -%>
+    });
+
+    setupGracefulShutdown(server);
+};
+
+module.exports = startServer;

package/templates/clean-architecture/js/src/infrastructure/webserver/swagger.js.ejs

@@ -1,6 +1,6 @@
-const path = require('path');
-const YAML = require('yamljs');
-
-const swaggerDocument = YAML.load(path.join(__dirname, 'swagger.yml'));
-
-module.exports = swaggerDocument;
+const path = require('path');
+const YAML = require('yamljs');
+
+const swaggerDocument = YAML.load(path.join(__dirname, 'swagger.yml'));
+
+module.exports = swaggerDocument;

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

@@ -1,13 +1,13 @@
-const UserRepository = require('../../infrastructure/repositories/UserRepository');
-
-const gqlContext = async ({ req }) => {
-  const token = req.headers.authorization || '';
-  const userRepository = new UserRepository();
-  
-  return { 
-    token, 
-    userRepository 
-  };
-};
-
-module.exports = { gqlContext };
+const UserRepository = require('../../infrastructure/repositories/UserRepository');
+
+const gqlContext = async ({ req }) => {
+  const token = req.headers.authorization || '';
+  const userRepository = new UserRepository();
+  
+  return { 
+    token, 
+    userRepository 
+  };
+};
+
+module.exports = { gqlContext };

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

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

package/templates/clean-architecture/js/src/interfaces/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/clean-architecture/js/src/interfaces/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/clean-architecture/js/src/interfaces/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 };