nodejs-structure-cli 1.0.2 → 1.0.3

package/templates/common/caching/js/memoryCache.js.ejs

@@ -1,5 +1,5 @@
-const NodeCache = require('node-cache');
-const logger = require('<%- loggerPath %>');
+import NodeCache from 'node-cache';
+import logger from '<%- loggerPath %>.js';
 
 class MemoryCacheService {
     constructor() {
@@ -57,4 +57,4 @@ class MemoryCacheService {
     }
 }
 
-module.exports = MemoryCacheService.getInstance();
+export default MemoryCacheService.getInstance();

package/templates/common/caching/js/redisClient.js.ejs

@@ -1,6 +1,8 @@
-const Redis = require('ioredis');
-require('dotenv').config();
-const logger = require('<%- loggerPath %>');
+import Redis from 'ioredis';
+import dotenv from 'dotenv';
+import logger from '<%- loggerPath %>.js';
+
+dotenv.config();
 
 class RedisService {
     constructor() {
@@ -72,4 +74,4 @@ class RedisService {
     }
 }
 
-module.exports = RedisService.getInstance();
+export default RedisService.getInstance();

package/templates/common/ecosystem.config.js.ejs

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   apps: [{
     name: "<%= projectName %>",
     script: "<% if (language === 'TypeScript') { %>./dist/index.js<% } else { %>./src/index.js<% } %>", // Entry point

package/templates/common/health/js/healthRoute.spec.js.ejs

@@ -1,13 +1,14 @@
-const request = require('supertest');
-const express = require('express');
+import request from 'supertest';
+import express from 'express';
 <% if (architecture === 'MVC') { -%>
-const healthRoute = require('@/routes/healthRoute');
+import healthRoute from '@/routes/healthRoute.js';
 <% } else { -%>
-const healthRoute = require('@/interfaces/routes/healthRoute');
+import healthRoute from '@/interfaces/routes/healthRoute.js';
 <% } -%>
-const HTTP_STATUS = require('@/utils/httpCodes');
+import HTTP_STATUS from '@/utils/httpCodes.js';
 
 <%_ if (database === 'MongoDB') { -%>
+import mongoose from 'mongoose';
 jest.mock('mongoose', () => {
     return {
         connection: {
@@ -21,9 +22,11 @@ jest.mock('mongoose', () => {
     };
 });
 <%_ } else if (database !== 'None') { -%>
-jest.mock('<% if (architecture === "MVC") { %>@/config/database<% } else { %>@/infrastructure/database/database<% } %>', () => {
+import sequelize from '<% if (architecture === "MVC") { %>@/config/database.js<% } else { %>@/infrastructure/database/database.js<% } %>';
+jest.mock('<% if (architecture === "MVC") { %>@/config/database.js<% } else { %>@/infrastructure/database/database.js<% } %>', () => {
     return {
-        authenticate: jest.fn()
+        authenticate: jest.fn(),
+        sync: jest.fn()
     };
 });
 <%_ } -%>
@@ -46,7 +49,6 @@ describe('Health Route', () => {
 
 <%_ if (database === 'MongoDB') { -%>
     it('should handle database ping failure and return 500', async () => {
-        const mongoose = require('mongoose');
         mongoose.connection.db.admin.mockReturnValueOnce({
             ping: jest.fn().mockRejectedValueOnce(new Error('DB Error'))
         });
@@ -58,7 +60,6 @@ describe('Health Route', () => {
     });
 <%_ } else if (database !== 'None') { -%>
     it('should handle database authentication failure and return 500', async () => {
-        const sequelize = require('<% if (architecture === "MVC") { %>@/config/database<% } else { %>@/infrastructure/database/database<% } %>');
         sequelize.authenticate.mockRejectedValueOnce(new Error('DB Error'));
 
         const res = await request(app).get('/health');

package/templates/common/jest.config.js.ejs

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   testEnvironment: 'node',
   coverageDirectory: 'coverage',
   collectCoverageFrom: ['src/**/*.{js,ts}'],

package/templates/common/jest.e2e.config.js.ejs

@@ -1,6 +1,7 @@
-<%_ if (language === 'TypeScript') { -%>/* eslint-disable @typescript-eslint/no-require-imports */<%_ } -%>
-module.exports = {
-  ...require('./jest.config'),
+import baseConfig from './jest.config.js';
+
+export default {
+  ...baseConfig,
   testMatch: ['<rootDir>/tests/e2e/**/*.test.ts', '<rootDir>/tests/e2e/**/*.test.js'],
   testPathIgnorePatterns: ['/node_modules/'],
   testTimeout: 30000,

package/templates/common/kafka/js/config/kafka.js

@@ -1,9 +1,9 @@
-const { Kafka } = require('kafkajs');
-const { env } = require('./env');
+import { Kafka } from 'kafkajs';
+import { env } from '../config/env.js';
 
 const kafka = new Kafka({
     clientId: 'nodejs-service',
     brokers: [env.KAFKA_BROKER]
 });
 
-module.exports = { kafka };
+export { kafka };

package/templates/common/kafka/js/messaging/baseConsumer.js.ejs

@@ -1,4 +1,4 @@
-const logger = require('<%- loggerPath %>');
+import logger from '<%- loggerPath %>.js';
 
 class BaseConsumer {
   constructor() {
@@ -27,4 +27,4 @@ class BaseConsumer {
   }
 }
 
-module.exports = BaseConsumer;
+export default BaseConsumer;

package/templates/common/kafka/js/messaging/userEventSchema.js.ejs

@@ -1,5 +1,5 @@
-const { z } = require('zod');
-const { KAFKA_ACTIONS } = require('<%- kafkaEventsPath %>');
+import { z } from 'zod';
+import { KAFKA_ACTIONS } from '<%- kafkaEventsPath %>.js';
 
 const UserEventSchema = z.object({
   action: z.enum(Object.values(KAFKA_ACTIONS)),
@@ -9,4 +9,4 @@ const UserEventSchema = z.object({
   }),
 });
 
-module.exports = { UserEventSchema };
+export { UserEventSchema };

package/templates/common/kafka/js/messaging/welcomeEmailConsumer.js.ejs

@@ -1,8 +1,8 @@
-const BaseConsumer = require('<%- baseConsumerPath %>');
-const logger = require('<%- loggerPath %>');
-const { UserEventSchema } = require('<%- userEventSchemaPath %>');
-const ERROR_MESSAGES = require('<%- errorMessagesPath %>');
-const { KAFKA_ACTIONS } = require('<%- kafkaEventsPath %>');
+import BaseConsumer from '<%- baseConsumerPath %>.js';
+import logger from '<%- loggerPath %>.js';
+import { UserEventSchema } from '<%- userEventSchemaPath %>.js';
+import ERROR_MESSAGES from '<%- errorMessagesPath %>.js';
+import { KAFKA_ACTIONS } from '<%- kafkaEventsPath %>.js';
 
 class WelcomeEmailConsumer extends BaseConsumer {
   constructor() {
@@ -41,4 +41,4 @@ class WelcomeEmailConsumer extends BaseConsumer {
   }
 }
 
-module.exports = WelcomeEmailConsumer;
+export default WelcomeEmailConsumer;

package/templates/common/kafka/js/services/kafkaService.js.ejs

@@ -1,5 +1,6 @@
-const { kafka } = require('../config/kafka');
-const logger = require('<% if (architecture === "Clean Architecture") { %>../log/logger<% } else { %>../utils/logger<% } %>');
+import { kafka } from '../config/kafka.js';
+import logger from '<% if (architecture === "Clean Architecture") { %>../log/logger.js<% } else { %>../utils/logger.js<% } %>';
+import WelcomeEmailConsumer from '<% if (architecture === "Clean Architecture") { %>../../interfaces/messaging/consumers/instances/welcomeEmailConsumer.js<% } else { %>../messaging/consumers/instances/welcomeEmailConsumer.js<% } %>';
 
 let producer = null;
 let consumer = null;
@@ -14,10 +15,7 @@ const connectKafka = async (retries = 10) => {
         if (!consumer) consumer = kafka.consumer({ groupId: 'test-group' });
 
         let attempt = 0;
-        // Auto-register WelcomeEmailConsumer if it exists
-        // Note: Dynamic import used here for simplicity and to avoid startup crashes.
-        // In enterprise production, consider using Dependency Injection.
-        const WelcomeEmailConsumer = require('<% if (architecture === "Clean Architecture") { %>../../interfaces/messaging/consumers/instances/welcomeEmailConsumer<% } else { %>../messaging/consumers/instances/welcomeEmailConsumer<% } %>');
+        
         while (attempt < retries) {
             try {
                 await producer.connect();
@@ -90,4 +88,4 @@ const disconnectKafka = async () => {
     if (consumer) await consumer.disconnect();
 };
 
-module.exports = { connectKafka, sendMessage, disconnectKafka };
+export { connectKafka, sendMessage, disconnectKafka };

package/templates/common/kafka/js/utils/kafkaEvents.js.ejs

@@ -1,7 +1,5 @@
-const KAFKA_ACTIONS = {
+export const KAFKA_ACTIONS = {
   USER_CREATED: 'USER_CREATED',
   USER_UPDATED: 'USER_UPDATED',
   USER_DELETED: 'USER_DELETED',
 };
-
-module.exports = { KAFKA_ACTIONS };

package/templates/common/migrate-mongo-config.js.ejs

@@ -25,7 +25,7 @@ const config = {
   useFileHash: false,
 
   // Don't change this, unless you know what you are doing
-  moduleSystem: 'commonjs',
+  moduleSystem: 'esm',
 };
 
-module.exports = config;
+export default config;

package/templates/common/migrations/init.js.ejs

@@ -1,23 +1,21 @@
-module.exports = {
-  async up(db, client) {
-    const adminEmail = 'admin@example.com';
-    const existingAdmin = await db.collection('users').findOne({ email: adminEmail });
+export const up = async (db, client) => {
+  const adminEmail = 'admin@example.com';
+  const existingAdmin = await db.collection('users').findOne({ email: adminEmail });
 
-    if (!existingAdmin) {
-      await db.collection('users').insertOne({
-        name: 'Admin User',
-        email: adminEmail,
-        createdAt: new Date(),
-        updatedAt: new Date()
-      });
-      console.log('Admin User seeded successfully');
-    } else {
-      console.log('Admin User already exists, skipping seed');
-    }
-  },
-
-  async down(db, client) {
-    // Optional: Undo the seed. Usually for seeds we might want to keep data, but strictly speaking 'down' should reverse 'up'.
-    // await db.collection('users').deleteOne({ email: 'admin@example.com' });
+  if (!existingAdmin) {
+    await db.collection('users').insertOne({
+      name: 'Admin User',
+      email: adminEmail,
+      createdAt: new Date(),
+      updatedAt: new Date()
+    });
+    console.log('Admin User seeded successfully');
+  } else {
+    console.log('Admin User already exists, skipping seed');
   }
 };
+
+export const down = async (db, client) => {
+  // Optional: Undo the seed. Usually for seeds we might want to keep data, but strictly speaking 'down' should reverse 'up'.
+  // await db.collection('users').deleteOne({ email: 'admin@example.com' });
+};

package/templates/common/scripts/run-e2e.js.ejs

@@ -1,6 +1,9 @@
-/* eslint-disable */
-const { execSync } = require('child_process');
-const path = require('path');
+import { execSync } from 'child_process';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 // Set a specific port for E2E tests to avoid collisions with local development
 process.env.PORT = '3001';

package/templates/common/src/dummy.ts

@@ -0,0 +1,3 @@
+// This file exists to satisfy the TypeScript compiler in the template directory.
+// It can be safely ignored or deleted in generated projects.
+export const dummy = true;

package/templates/common/src/tests/e2e/e2e.users.test.js.ejs

@@ -1,4 +1,4 @@
-const request = require('supertest');
+import request from 'supertest';
 
 const SERVER_URL = process.env.TEST_URL || `http://127.0.0.1:${process.env.PORT || 3001}`;
 

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

@@ -1,9 +1,9 @@
-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<% } %>');
+import { errorMiddleware } from '<% if (architecture === "MVC") { %>@/utils/errorMiddleware.js<% } else { %>@/infrastructure/webserver/middleware/errorMiddleware.js<% } %>';
+import { ApiError } from '@/errors/ApiError.js';
+import HTTP_STATUS from '@/utils/httpCodes.js';
+import logger from '<% if (architecture === "MVC") { %>@/utils/logger.js<% } else { %>@/infrastructure/log/logger.js<% } %>';
 
-jest.mock('<% if (architecture === "MVC") { %>@/utils/logger<% } else { %>@/infrastructure/log/logger<% } %>');
+jest.mock('<% if (architecture === "MVC") { %>@/utils/logger.js<% } else { %>@/infrastructure/log/logger.js<% } %>');
 
 describe('Error Middleware', () => {
     let mockRequest;
@@ -68,7 +68,6 @@ describe('Error Middleware', () => {
     });
 
     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);

package/templates/common/tsconfig.json

@@ -1,7 +1,8 @@
 {
     "compilerOptions": {
         "target": "es2020",
-        "module": "commonjs",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
         "outDir": "./dist",
         "rootDir": "./src",
         "strict": true,

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

@@ -1,17 +1,17 @@
-const HTTP_STATUS = require('@/utils/httpCodes');
-const ERROR_MESSAGES = require('@/utils/errorMessages');
+import HTTP_STATUS from '@/utils/httpCodes.js';
+import ERROR_MESSAGES from '@/utils/errorMessages.js';
 <% if (communication !== 'GraphQL') { -%>
 // Express-only imports would go here
 <% } -%>
-const { getUsers, createUser, updateUser, deleteUser } = require('@/controllers/userController');
+import { getUsers, createUser, updateUser, deleteUser } from '@/controllers/userController.js';
 <%_ if (caching === 'Redis') { -%>
-const cacheService = require('@/config/redisClient');
+import cacheService from '@/config/redisClient.js';
 <%_ } else if (caching === 'Memory Cache') { -%>
-const cacheService = require('@/config/memoryCache');
+import cacheService from '@/config/memoryCache.js';
 <%_ } -%>
 
 // Mock dependencies
-jest.mock('@/models/User', () => {
+jest.mock('@/models/User.js', () => {
     return {
         create: jest.fn(),
         find: jest.fn(),
@@ -25,23 +25,23 @@ jest.mock('@/models/User', () => {
         mockData: []
     };
 });
-const User = require('@/models/User');
+import User from '@/models/User.js';
 <%_ if (caching === 'Redis') { -%>
-jest.mock('@/config/redisClient', () => ({
+jest.mock('@/config/redisClient.js', () => ({
     getOrSet: jest.fn((_key, fetcher) => fetcher()),
     del: jest.fn(),
     flush: jest.fn()
 }));
 <%_ } else if (caching === 'Memory Cache') { -%>
-jest.mock('@/config/memoryCache', () => ({
+jest.mock('@/config/memoryCache.js', () => ({
     getOrSet: jest.fn((_key, fetcher) => fetcher()),
     del: jest.fn(),
     flush: jest.fn()
 }));
 <%_ } -%>
-jest.mock('@/utils/logger');
+jest.mock('@/utils/logger.js');
 <%_ if (communication === 'Kafka') { -%>
-jest.mock('@/services/kafkaService', () => {
+jest.mock('@/services/kafkaService.js', () => {
     const mockSendMessage = jest.fn().mockResolvedValue(undefined);
     return {
         sendMessage: mockSendMessage,
@@ -53,7 +53,7 @@ jest.mock('@/services/kafkaService', () => {
         }))
     };
 });
-const { sendMessage } = require('@/services/kafkaService');
+import { sendMessage } from '@/services/kafkaService.js';
 <%_ } -%>
 
 

package/templates/mvc/js/src/errors/ApiError.js

@@ -11,4 +11,4 @@ class ApiError extends Error {
   }
 }
 
-module.exports = { ApiError };
+export { ApiError };

package/templates/mvc/js/src/errors/BadRequestError.js

@@ -1,6 +1,6 @@
-const { ApiError } = require('./ApiError');
-const HTTP_STATUS = require('../utils/httpCodes');
-const ERROR_MESSAGES = require('../utils/errorMessages');
+import { ApiError } from './ApiError.js';
+import HTTP_STATUS from '../utils/httpCodes.js';
+import ERROR_MESSAGES from '../utils/errorMessages.js';
 
 class BadRequestError extends ApiError {
   constructor(message = ERROR_MESSAGES.BAD_REQUEST) {
@@ -8,4 +8,4 @@ class BadRequestError extends ApiError {
   }
 }
 
-module.exports = { BadRequestError };
+export { BadRequestError };

package/templates/mvc/js/src/errors/BadRequestError.spec.js.ejs

@@ -1,7 +1,7 @@
-const { BadRequestError } = require('@/errors/BadRequestError');
-const { ApiError } = require('@/errors/ApiError');
-const HTTP_STATUS = require('@/utils/httpCodes');
-const ERROR_MESSAGES = require('@/utils/errorMessages');
+import { BadRequestError } from '@/errors/BadRequestError.js';
+import { ApiError } from '@/errors/ApiError.js';
+import HTTP_STATUS from '@/utils/httpCodes.js';
+import ERROR_MESSAGES from '@/utils/errorMessages.js';
 
 describe('BadRequestError', () => {
     it('should extend ApiError', () => {

package/templates/mvc/js/src/errors/NotFoundError.js

@@ -1,6 +1,6 @@
-const { ApiError } = require('./ApiError');
-const HTTP_STATUS = require('../utils/httpCodes');
-const ERROR_MESSAGES = require('../utils/errorMessages');
+import { ApiError } from './ApiError.js';
+import HTTP_STATUS from '../utils/httpCodes.js';
+import ERROR_MESSAGES from '../utils/errorMessages.js';
 
 class NotFoundError extends ApiError {
   constructor(message = ERROR_MESSAGES.RESOURCE_NOT_FOUND) {
@@ -8,4 +8,4 @@ class NotFoundError extends ApiError {
   }
 }
 
-module.exports = { NotFoundError };
+export { NotFoundError };

package/templates/mvc/js/src/errors/NotFoundError.spec.js.ejs

@@ -1,7 +1,7 @@
-const { NotFoundError } = require('@/errors/NotFoundError');
-const { ApiError } = require('@/errors/ApiError');
-const HTTP_STATUS = require('@/utils/httpCodes');
-const ERROR_MESSAGES = require('@/utils/errorMessages');
+import { NotFoundError } from '@/errors/NotFoundError.js';
+import { ApiError } from '@/errors/ApiError.js';
+import HTTP_STATUS from '@/utils/httpCodes.js';
+import ERROR_MESSAGES from '@/utils/errorMessages.js';
 
 describe('NotFoundError', () => {
     it('should extend ApiError', () => {

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

@@ -4,4 +4,4 @@ const gqlContext = async ({ req }) => {
   return { token };
 };
 
-module.exports = { gqlContext };
+export { gqlContext };

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');
+import { typeDefs } from './typeDefs/index.js';
+import { resolvers } from './resolvers/index.js';
+import { gqlContext } from './context.js';
 
-module.exports = { typeDefs, resolvers, gqlContext };
+export { typeDefs, resolvers, gqlContext };

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

@@ -1,6 +1,6 @@
-const { mergeResolvers } = require('@graphql-tools/merge');
-const { userResolvers } = require('./user.resolvers');
+import { mergeResolvers } from '@graphql-tools/merge';
+import { userResolvers } from './user.resolvers.js';
 
 const resolvers = mergeResolvers([userResolvers]);
 
-module.exports = { resolvers };
+export { resolvers };

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

@@ -1,4 +1,4 @@
-const userController = require('../../controllers/userController');
+import * as userController from '../../controllers/userController.js';
 
 const userResolvers = {
   Query: {
@@ -22,4 +22,4 @@ const userResolvers = {
   }<%_ } %>
 };
 
-module.exports = { userResolvers };
+export { userResolvers };

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

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

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

@@ -1,4 +1,4 @@
-const userTypes = `#graphql
+export const userTypes = `#graphql
   type User {
     id: ID!
     name: String!
@@ -16,4 +16,4 @@ const userTypes = `#graphql
   }
 `;
 
-module.exports = { userTypes };
+

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

@@ -1,6 +1,6 @@
-const request = require('supertest');
-const express = require('express');
-const router = require('@/routes/api');
+import request from 'supertest';
+import express from 'express';
+import router from '@/routes/api.js';
 
 const mockGetUsers = jest.fn().mockImplementation((req, res) => res.status(200).json([{ id: '1', name: 'John Doe' }]));
 const mockCreateUser = jest.fn().mockImplementation((req, res) => res.status(201).json({ id: '1', name: 'Test' }));
@@ -8,7 +8,7 @@ const mockCreateUser = jest.fn().mockImplementation((req, res) => res.status(201
 const mockUpdateUser = jest.fn().mockImplementation((req, res) => res.status(200).json({ id: '1', name: 'Updated' }));
 const mockDeleteUser = jest.fn().mockImplementation((req, res) => res.status(200).json({ message: 'User deleted successfully' }));
 
-jest.mock('@/controllers/userController', () => ({
+jest.mock('@/controllers/userController.js', () => ({
   getUsers: (...args) => mockGetUsers(...args),
   createUser: (...args) => mockCreateUser(...args),
   updateUser: (...args) => mockUpdateUser(...args),