nodejs-structure-cli 1.0.0

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

@@ -0,0 +1,79 @@
+const { errorMiddleware } = require('<% if (architecture === "MVC") { %>@/utils/errorMiddleware<% } else { %>@/infrastructure/webserver/middleware/errorMiddleware<% } %>');
+const { ApiError } = require('@/errors/ApiError');
+const HTTP_STATUS = require('@/utils/httpCodes');
+const logger = require('<% 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;
+    let mockResponse;
+    let nextFunction;
+    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, mockResponse, nextFunction);
+
+        expect(logger.error).toHaveBeenCalled();
+        expect(mockResponse.status).toHaveBeenCalledWith(HTTP_STATUS.INTERNAL_SERVER_ERROR);
+    });
+
+    it('should handle custom ApiError directly', () => {
+        const customError = new ApiError(HTTP_STATUS.BAD_REQUEST, 'Bad Request Data', true);
+        errorMiddleware(customError, mockRequest, mockResponse, nextFunction);
+
+        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, mockResponse, 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, mockResponse, nextFunction);
+
+        const jsonArg = mockResponse.json.mock.calls[0][0];
+        expect(jsonArg.stack).toBeUndefined();
+    });
+
+    it('should handle error without stack trace', () => {
+        const { ApiError } = require('@/errors/ApiError');
+        const customError = new ApiError(500, 'No Stack', false);
+        delete customError.stack;
+        errorMiddleware(customError, mockRequest, mockResponse, nextFunction);
+
+        expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('No Stack'));
+        expect(logger.error).toHaveBeenCalledWith('No stack trace');
+    });
+});

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

@@ -0,0 +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');
+    });
+});

package/templates/common/swagger.yml.ejs

@@ -0,0 +1,118 @@
+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
+  /api/users/{id}:
+    patch:
+      summary: Update an existing user
+      tags:
+        - Users
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: string
+          required: true
+          description: The user id
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                email:
+                  type: string
+      responses:
+        '200':
+          description: The updated user
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        '404':
+          description: User not found
+        '500':
+          description: Some server error
+    delete:
+      summary: Delete an existing user
+      tags:
+        - Users
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: string
+          required: true
+          description: The user id
+      responses:
+        '200':
+          description: User deleted successfully
+        '404':
+          description: User not found
+        '500':
+          description: Some server error

package/templates/common/tsconfig.json

@@ -0,0 +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"
+    ]
+}

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

@@ -0,0 +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>

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

@@ -0,0 +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

package/templates/db/mysql/V1__Initial_Setup.sql.ejs

@@ -0,0 +1,10 @@
+CREATE TABLE users (
+    id INT AUTO_INCREMENT PRIMARY KEY,
+    name VARCHAR(255) NOT NULL,
+    email VARCHAR(255) NOT NULL UNIQUE,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+    deleted_at TIMESTAMP NULL
+);
+
+INSERT INTO users (name, email) VALUES ('Admin User', 'admin@example.com');

package/templates/db/postgres/V1__Initial_Setup.sql.ejs

@@ -0,0 +1,10 @@
+CREATE TABLE users (
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(255) NOT NULL,
+    email VARCHAR(255) NOT NULL UNIQUE,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    deleted_at TIMESTAMP NULL
+);
+
+INSERT INTO users (name, email) VALUES ('Admin User', 'admin@example.com');

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

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

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

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