nodejs-quickstart-structure 1.19.0 → 1.19.1

package/templates/common/src/utils/errorMiddleware.spec.ts.ejs

@@ -1,94 +1,94 @@
-import { errorMiddleware } from '<% if (architecture === "MVC" || language === "TypeScript") { %>@/utils/errorMiddleware<% } else { %>@/infrastructure/webserver/middleware/errorMiddleware<% } %>';
-import { Request, Response } from 'express';
-import { ApiError } from '@/errors/ApiError';
-import { HTTP_STATUS } from '@/utils/httpCodes';
-import logger from '<% if (architecture === "MVC") { %>@/utils/logger<% } else { %>@/infrastructure/log/logger<% } %>';
-
-jest.mock('<% if (architecture === "MVC") { %>@/utils/logger<% } else { %>@/infrastructure/log/logger<% } %>');
-
-describe('Error Middleware', () => {
-    let mockRequest: Partial<Request>;
-    let mockResponse: Partial<Response>;
-    let nextFunction: jest.Mock;
-    const originalEnv = process.env.NODE_ENV;
-
-    beforeEach(() => {
-        mockRequest = {
-            originalUrl: '/test',
-            method: 'GET',
-            ip: '127.0.0.1'
-        };
-        mockResponse = {
-            status: jest.fn().mockReturnThis(),
-            json: jest.fn()
-        };
-        nextFunction = jest.fn();
-        jest.clearAllMocks();
-    });
-
-    afterEach(() => {
-        process.env.NODE_ENV = originalEnv;
-    });
-
-    it('should handle standard Error by wrapping it in a 500 ApiError', () => {
-        const error = new Error('Standard Error');
-        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
-
-        expect(logger.error).toHaveBeenCalled();
-        expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.INTERNAL_SERVER_ERROR);
-        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
-            statusCode: HTTP_STATUS.INTERNAL_SERVER_ERROR,
-            message: 'Standard Error'
-        }));
-    });
-
-    it('should default to Internal Server Error message if none provided on Error', () => {
-        const error = new Error();
-        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
-
-        expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.INTERNAL_SERVER_ERROR);
-        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
-            message: 'Internal Server Error'
-        }));
-    });
-
-    it('should handle custom ApiError directly', () => {
-        const customError = new ApiError(HTTP_STATUS.BAD_REQUEST, 'Bad Request Data', true);
-        errorMiddleware(customError, mockRequest as Request, mockResponse as Response, nextFunction);
-
-        expect(logger.error).not.toHaveBeenCalled();
-        expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.BAD_REQUEST);
-        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
-            statusCode: HTTP_STATUS.BAD_REQUEST,
-            message: 'Bad Request Data'
-        }));
-    });
-
-    it('should include stack trace in development environment', () => {
-        process.env.NODE_ENV = 'development';
-        const error = new Error('Test Error');
-        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
-
-        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
-            stack: expect.any(String)
-        }));
-    });
-
-    it('should omit stack trace in production environment', () => {
-        process.env.NODE_ENV = 'production';
-        const error = new Error('Test Error');
-        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
-
-        const jsonArg = (mockResponse.json as jest.Mock).mock.calls[0][0];
-        expect(jsonArg.stack).toBeUndefined();
-    });
-
-    it('should handle error without stack trace', () => {
-        const customError = new ApiError(HTTP_STATUS.INTERNAL_SERVER_ERROR, 'No Stack', false);
-        delete customError.stack;
-        errorMiddleware(customError, mockRequest as Request, mockResponse as Response, nextFunction);
-
-        expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('No Stack'));
-        expect(logger.error).toHaveBeenCalledWith('No stack trace');
-    });
-});
+import { errorMiddleware } from '<% if (architecture === "MVC" || language === "TypeScript") { %>@/utils/errorMiddleware<% } else { %>@/infrastructure/webserver/middleware/errorMiddleware<% } %>';
+import { Request, Response } from 'express';
+import { ApiError } from '@/errors/ApiError';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+import logger from '<% if (architecture === "MVC") { %>@/utils/logger<% } else { %>@/infrastructure/log/logger<% } %>';
+
+jest.mock('<% if (architecture === "MVC") { %>@/utils/logger<% } else { %>@/infrastructure/log/logger<% } %>');
+
+describe('Error Middleware', () => {
+    let mockRequest: Partial<Request>;
+    let mockResponse: Partial<Response>;
+    let nextFunction: jest.Mock;
+    const originalEnv = process.env.NODE_ENV;
+
+    beforeEach(() => {
+        mockRequest = {
+            originalUrl: '/test',
+            method: 'GET',
+            ip: '127.0.0.1'
+        };
+        mockResponse = {
+            status: jest.fn().mockReturnThis(),
+            json: jest.fn()
+        };
+        nextFunction = jest.fn();
+        jest.clearAllMocks();
+    });
+
+    afterEach(() => {
+        process.env.NODE_ENV = originalEnv;
+    });
+
+    it('should handle standard Error by wrapping it in a 500 ApiError', () => {
+        const error = new Error('Standard Error');
+        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
+
+        expect(logger.error).toHaveBeenCalled();
+        expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.INTERNAL_SERVER_ERROR);
+        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
+            statusCode: HTTP_STATUS.INTERNAL_SERVER_ERROR,
+            message: 'Standard Error'
+        }));
+    });
+
+    it('should default to Internal Server Error message if none provided on Error', () => {
+        const error = new Error();
+        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
+
+        expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.INTERNAL_SERVER_ERROR);
+        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
+            message: 'Internal Server Error'
+        }));
+    });
+
+    it('should handle custom ApiError directly', () => {
+        const customError = new ApiError(HTTP_STATUS.BAD_REQUEST, 'Bad Request Data', true);
+        errorMiddleware(customError, mockRequest as Request, mockResponse as Response, nextFunction);
+
+        expect(logger.error).not.toHaveBeenCalled();
+        expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.BAD_REQUEST);
+        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
+            statusCode: HTTP_STATUS.BAD_REQUEST,
+            message: 'Bad Request Data'
+        }));
+    });
+
+    it('should include stack trace in development environment', () => {
+        process.env.NODE_ENV = 'development';
+        const error = new Error('Test Error');
+        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
+
+        expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({
+            stack: expect.any(String)
+        }));
+    });
+
+    it('should omit stack trace in production environment', () => {
+        process.env.NODE_ENV = 'production';
+        const error = new Error('Test Error');
+        errorMiddleware(error, mockRequest as Request, mockResponse as Response, nextFunction);
+
+        const jsonArg = (mockResponse.json as jest.Mock).mock.calls[0][0];
+        expect(jsonArg.stack).toBeUndefined();
+    });
+
+    it('should handle error without stack trace', () => {
+        const customError = new ApiError(HTTP_STATUS.INTERNAL_SERVER_ERROR, 'No Stack', false);
+        delete customError.stack;
+        errorMiddleware(customError, mockRequest as Request, mockResponse as Response, nextFunction);
+
+        expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('No Stack'));
+        expect(logger.error).toHaveBeenCalledWith('No stack trace');
+    });
+});

package/templates/common/tsconfig.json

@@ -1,23 +1,23 @@
-{
-    "compilerOptions": {
-        "target": "es2020",
-        "module": "commonjs",
-        "outDir": "./dist",
-        "rootDir": "./src",
-        "strict": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "forceConsistentCasingInFileNames": true,
-        "baseUrl": ".",
-        "paths": {
-            "@/*": ["src/*"]
-        }
-    },
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "node_modules",
-        "dist"
-    ]
+{
+    "compilerOptions": {
+        "target": "es2020",
+        "module": "commonjs",
+        "outDir": "./dist",
+        "rootDir": "./src",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "baseUrl": ".",
+        "paths": {
+            "@/*": ["src/*"]
+        }
+    },
+    "include": [
+        "src/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist"
+    ]
 }

package/templates/common/views/ejs/index.ejs

@@ -1,55 +1,55 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title><%= projectName %></title>
-    <link rel="stylesheet" href="/css/style.css">
-</head>
-<body>
-    <div class="container">
-        <header class="header">
-            <div class="logo">🚀</div>
-            <h1>Welcome to <%= projectName %></h1>
-            <p class="subtitle">A production-ready Node.js microservice starter.</p>
-        </header>
-
-        <div class="card-grid">
-            <div class="card">
-                <h3>Architecture</h3>
-                <p><%= architecture %></p>
-            </div>
-            <div class="card">
-                <h3>Database</h3>
-                <p><%= database %></p>
-            </div>
-            <div class="card">
-                <h3>Communication</h3>
-                <p><%= communication %></p>
-            </div>
-        </div>
-
-        <% if (communication === 'Kafka') { %>
-        <div class="status-card">
-            <div class="status-icon">🔄</div>
-            <div class="status-content">
-                <h3>Kafka Connected</h3>
-                <p>Connection to broker established successfully.</p>
-            </div>
-        </div>
-        <% } else { %>
-        <div class="status-card">
-            <div class="status-icon">✅</div>
-            <div class="status-content">
-                <h3>API Active</h3>
-                <p>REST API is running and ready to accept requests.</p>
-            </div>
-        </div>
-        <% } %>
-
-        <footer>
-            <p>Generated with ❤️ by Node.js Quickstart Generator</p>
-        </footer>
-    </div>
-</body>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= projectName %></title>
+    <link rel="stylesheet" href="/css/style.css">
+</head>
+<body>
+    <div class="container">
+        <header class="header">
+            <div class="logo">🚀</div>
+            <h1>Welcome to <%= projectName %></h1>
+            <p class="subtitle">A production-ready Node.js microservice starter.</p>
+        </header>
+
+        <div class="card-grid">
+            <div class="card">
+                <h3>Architecture</h3>
+                <p><%= architecture %></p>
+            </div>
+            <div class="card">
+                <h3>Database</h3>
+                <p><%= database %></p>
+            </div>
+            <div class="card">
+                <h3>Communication</h3>
+                <p><%= communication %></p>
+            </div>
+        </div>
+
+        <% if (communication === 'Kafka') { %>
+        <div class="status-card">
+            <div class="status-icon">🔄</div>
+            <div class="status-content">
+                <h3>Kafka Connected</h3>
+                <p>Connection to broker established successfully.</p>
+            </div>
+        </div>
+        <% } else { %>
+        <div class="status-card">
+            <div class="status-icon">✅</div>
+            <div class="status-content">
+                <h3>API Active</h3>
+                <p>REST API is running and ready to accept requests.</p>
+            </div>
+        </div>
+        <% } %>
+
+        <footer>
+            <p>Generated with ❤️ by Node.js Quickstart Generator</p>
+        </footer>
+    </div>
+</body>
+</html>

package/templates/common/views/pug/index.pug

@@ -1,40 +1,40 @@
-doctype html
-html(lang="en")
-  head
-    meta(charset="UTF-8")
-    meta(name="viewport", content="width=device-width, initial-scale=1.0")
-    title= projectName
-    link(rel="stylesheet", href="/css/style.css")
-  body
-    .container
-      header.header
-        .logo 🚀
-        h1 Welcome to #{projectName}
-        p.subtitle A production-ready Node.js microservice starter.
-
-      .card-grid
-        .card
-          h3 Architecture
-          p #{architecture}
-        .card
-          h3 Database
-          p #{database}
-        .card
-          h3 Communication
-          p #{communication}
-
-      if communication === 'Kafka'
-        .status-card
-          .status-icon 🔄
-          .status-content
-            h3 Kafka Connected
-            p Connection to broker established successfully.
-      else 
-        .status-card
-          .status-icon ✅
-          .status-content
-            h3 API Active
-            p REST API is running and ready to accept requests.
-
-      footer
-        p Generated with ❤️ by Node.js Quickstart Generator
+doctype html
+html(lang="en")
+  head
+    meta(charset="UTF-8")
+    meta(name="viewport", content="width=device-width, initial-scale=1.0")
+    title= projectName
+    link(rel="stylesheet", href="/css/style.css")
+  body
+    .container
+      header.header
+        .logo 🚀
+        h1 Welcome to #{projectName}
+        p.subtitle A production-ready Node.js microservice starter.
+
+      .card-grid
+        .card
+          h3 Architecture
+          p #{architecture}
+        .card
+          h3 Database
+          p #{database}
+        .card
+          h3 Communication
+          p #{communication}
+
+      if communication === 'Kafka'
+        .status-card
+          .status-icon 🔄
+          .status-content
+            h3 Kafka Connected
+            p Connection to broker established successfully.
+      else 
+        .status-card
+          .status-icon ✅
+          .status-content
+            h3 API Active
+            p REST API is running and ready to accept requests.
+
+      footer
+        p Generated with ❤️ by Node.js Quickstart Generator

package/templates/mvc/js/src/config/env.js.ejs

@@ -1,46 +1,46 @@
-const { z } = require('zod');
-const logger = require('../utils/logger');
-
-if (process.env.NODE_ENV !== 'production') {
-  require('dotenv').config();
-}
-const envSchema = z.object({
-  NODE_ENV: z.enum(['development', 'production', 'test']).default('development'),
-  PORT: z.string().transform(Number).default('3000'),
-<%_ if (database !== 'None') { -%>
-  DB_HOST: z.string(),
-<%_ if (database === 'MySQL') { -%>
-  DB_USER: z.string(),
-  DB_PASSWORD: z.string(),
-  DB_NAME: z.string(),
-  DB_PORT: z.string().transform(Number),
-<%_ } else if (database === 'PostgreSQL') { -%>
-  DB_USER: z.string(),
-  DB_PASSWORD: z.string(),
-  DB_NAME: z.string(),
-  DB_PORT: z.string().transform(Number),
-<%_ } else if (database === 'MongoDB') { -%>
-  DB_NAME: z.string(),
-  DB_PORT: z.string().transform(Number),
-<%_ } -%>
-<%_ } -%>
-<%_ if (caching === 'Redis') { -%>
-  REDIS_HOST: z.string(),
-  REDIS_PORT: z.string().transform(Number),
-  REDIS_PASSWORD: z.string().optional(),
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-  KAFKA_BROKER: z.string(),
-<%_ } -%>
-});
-
-const _env = envSchema.safeParse(process.env);
-
-if (!_env.success) {
-  logger.error('❌ Invalid environment variables:', _env.error.format());
-  process.exit(1);
-}
-
-const env = _env.data;
-
-module.exports = { env };
+const { z } = require('zod');
+const logger = require('../utils/logger');
+
+if (process.env.NODE_ENV !== 'production') {
+  require('dotenv').config();
+}
+const envSchema = z.object({
+  NODE_ENV: z.enum(['development', 'production', 'test']).default('development'),
+  PORT: z.string().transform(Number).default('3000'),
+<%_ if (database !== 'None') { -%>
+  DB_HOST: z.string(),
+<%_ if (database === 'MySQL') { -%>
+  DB_USER: z.string(),
+  DB_PASSWORD: z.string(),
+  DB_NAME: z.string(),
+  DB_PORT: z.string().transform(Number),
+<%_ } else if (database === 'PostgreSQL') { -%>
+  DB_USER: z.string(),
+  DB_PASSWORD: z.string(),
+  DB_NAME: z.string(),
+  DB_PORT: z.string().transform(Number),
+<%_ } else if (database === 'MongoDB') { -%>
+  DB_NAME: z.string(),
+  DB_PORT: z.string().transform(Number),
+<%_ } -%>
+<%_ } -%>
+<%_ if (caching === 'Redis') { -%>
+  REDIS_HOST: z.string(),
+  REDIS_PORT: z.string().transform(Number),
+  REDIS_PASSWORD: z.string().optional(),
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+  KAFKA_BROKER: z.string(),
+<%_ } -%>
+});
+
+const _env = envSchema.safeParse(process.env);
+
+if (!_env.success) {
+  logger.error('❌ Invalid environment variables:', _env.error.format());
+  process.exit(1);
+}
+
+const env = _env.data;
+
+module.exports = { env };

package/templates/mvc/js/src/config/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/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/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 };