crypt-express-app 1.0.0 → 1.3.1

package/dist/scripts/generate-module.js

@@ -1,59 +1,22 @@
 // generate-module.ts
 import * as fs from 'fs';
 import * as path from 'path';
-// get module name from command line
-const args = process.argv.slice(2);
-// Check that exactly **one argument** is provided
-if (args.length !== 1) {
-    console.error('Invalid module name: provide exactly one module name without spaces.');
-    console.error('Example: npm run generate-module clientRole');
-    process.exit(1);
-}
-const moduleInput = args[0];
-// Reject if input contains spaces
-if (/\s/.test(moduleInput)) {
-    console.error('Invalid module name: spaces are not allowed. Use camelCase, kebab-case or snake_case.');
-    process.exit(1);
-}
-if (!moduleInput) {
-    console.error('Please provide a module name: npm run generate-module <module-name>');
-    process.exit(1);
-}
-// Convert any input to camelCase
-const moduleName = moduleInput.includes('-') || moduleInput.includes('_') || moduleInput.includes(' ')
-    ? moduleInput
-        .toLowerCase()
-        .replace(/[-_\s]+(.)/g, (_, c) => c.toUpperCase())
-    : moduleInput; // preserve existing camelCase
-console.log("moduleName: ", moduleName);
-// Convert any input (camelCase, PascalCase, snake_case, spaces) to kebab-case
-const fileName = moduleName
-    .replace(/([a-z])([A-Z])/g, '$1-$2') // add dash before uppercase letters
-    .toLowerCase(); // lowercase everything
-console.log("fileName: ", fileName);
-// const basePath = path.join(__dirname, '..', 'src', 'modules', fileName);
-// const basePath = path.join(__dirname, '..', 'src', 'modules', fileName);
-const projectRoot = process.cwd();
-const modulesRoot = path.join(projectRoot, "src", "modules");
-const basePath = path.join(modulesRoot, fileName);
-// ensure modules directory exists
-if (!fs.existsSync(modulesRoot)) {
-    fs.mkdirSync(modulesRoot, { recursive: true });
-}
-// prevent overwrite
-if (fs.existsSync(basePath)) {
-    console.error(`❌ Module '${fileName}' already exists.`);
-    process.exit(1);
-}
-fs.mkdirSync(basePath, { recursive: true });
-// Create folder
-if (!fs.existsSync(basePath)) {
-    fs.mkdirSync(basePath, { recursive: true });
-}
-// Capitalize first letter
-const ModuleClassName = moduleName.charAt(0).toUpperCase() + moduleName.slice(1);
-// Service
-const serviceContent = `import { Create${ModuleClassName}Dto, Update${ModuleClassName}Dto, Create${ModuleClassName}Response, Update${ModuleClassName}Response, Get${ModuleClassName}Response, List${ModuleClassName}Response } from "./${fileName}.dto";
+export function generateModule(projectDir, moduleName) {
+    // Convert any input (camelCase, PascalCase, snake_case, spaces) to kebab-case
+    const fileName = moduleName
+        .replace(/([a-z])([A-Z])/g, '$1-$2') // add dash before uppercase letters
+        .toLowerCase(); // lowercase everything
+    console.log("fileName: ", fileName);
+    const basePath = path.join(projectDir, 'src', 'modules', fileName);
+    // Create folder
+    if (!fs.existsSync(basePath)) {
+        fs.mkdirSync(basePath, { recursive: true });
+    }
+    // Capitalize first letter
+    const ModuleClassName = moduleName.charAt(0).toUpperCase() + moduleName.slice(1);
+    // Service
+    const serviceContent = `
+import { Create${ModuleClassName}Dto, Update${ModuleClassName}Dto, Create${ModuleClassName}Response, Update${ModuleClassName}Response, Get${ModuleClassName}Response, List${ModuleClassName}Response } from "./${fileName}.dto";
 import { Prisma } from "@prisma/client";
 import prisma from '../../prisma/client';
 import { PaginationRequestDto } from "../common/common.dto";
@@ -140,9 +103,9 @@ export class ${ModuleClassName}Service {
 
 export default new ${ModuleClassName}Service()
 `;
-fs.writeFileSync(path.join(basePath, `${fileName}.service.ts`), serviceContent);
-// Controller
-const controllerContent = `
+    fs.writeFileSync(path.join(basePath, `${fileName}.service.ts`), serviceContent);
+    // Controller
+    const controllerContent = `
 import { Request, Response } from 'express';
 import { ${ModuleClassName}Service } from './${fileName}.service';
 import { 
@@ -257,21 +220,21 @@ export class ${ModuleClassName}Controller {
   }
 }
 `;
-fs.writeFileSync(path.join(basePath, `${fileName}.controller.ts`), controllerContent);
-// Routes
-const routesContent = `
+    fs.writeFileSync(path.join(basePath, `${fileName}.controller.ts`), controllerContent);
+    // Routes
+    const routesContent = `
 import express, { Router } from 'express';
 import { ${ModuleClassName}Controller } from './${fileName}.controller';
 import { ${moduleName}Middleware } from './${fileName}.middlewares';
 import { authMiddleware } from '../../middlewares/auth.middleware';
 import ${moduleName}Service from './${fileName}.service';
-import { ActionsType, Resource, ResourceType } from '../../utils/consts';
+import { TypeAction, Resource, TypeResource } from '../../utils/consts';
 import { authorizationMiddleware } from '../../middlewares/authorization.middleware';
 
 const router: Router = express.Router();
 const controller = new ${ModuleClassName}Controller(${moduleName}Service);
 router.use(authMiddleware);
-const guard = (actions: ActionsType[]) => authorizationMiddleware({ resource: Resource.COMMON, actions, resourceType: ResourceType.API_ENDPOINT });
+const guard = (actions: TypeAction[]) => authorizationMiddleware({ resource: Resource.COMMON, actions, resourceType: TypeResource.API_ENDPOINT });
 
 /**
  * @openapi
@@ -300,7 +263,7 @@ const guard = (actions: ActionsType[]) => authorizationMiddleware({ resource: Re
  *             schema:
  *               $ref: '#/components/schemas/Create${ModuleClassName}ResponseDto'
  */
-router.post('/', ${moduleName}Middleware, guard([ActionsType.CREATE]), controller.create.bind(controller));
+router.post('/', ${moduleName}Middleware, guard([TypeAction.CREATE]), controller.create.bind(controller));
 
 /**
  * @openapi
@@ -322,7 +285,7 @@ router.post('/', ${moduleName}Middleware, guard([ActionsType.CREATE]), controlle
  *             schema:
  *               $ref: '#/components/schemas/Get${ModuleClassName}ResponseDto'
  */
-router.get('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.READ]), controller.getById.bind(controller));
+router.get('/:${moduleName}Id', ${moduleName}Middleware, guard([TypeAction.READ]), controller.getById.bind(controller));
 
 /**
  * @openapi
@@ -350,7 +313,7 @@ router.get('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.READ
  *             schema:
  *               $ref: '#/components/schemas/Update${ModuleClassName}ResponseDto'
  */
-router.put('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.UPDATE]), controller.update.bind(controller));
+router.put('/:${moduleName}Id', ${moduleName}Middleware, guard([TypeAction.UPDATE]), controller.update.bind(controller));
 
 /**
  * @openapi
@@ -379,7 +342,7 @@ router.put('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.UPDA
  *                 message:
  *                   type: string
  */
-router.delete('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.DELETE]), controller.delete.bind(controller));
+router.delete('/:${moduleName}Id', ${moduleName}Middleware, guard([TypeAction.DELETE]), controller.delete.bind(controller));
 
 /**
  * @openapi
@@ -422,7 +385,7 @@ router.delete('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.D
  *             schema:
  *               $ref: '#/components/schemas/List${ModuleClassName}ResponseDto'
  */
-router.get('/', ${moduleName}Middleware, guard([ActionsType.READ_ALL]), controller.list.bind(controller));
+router.get('/', ${moduleName}Middleware, guard([TypeAction.READ_ALL]), controller.list.bind(controller));
 
 /**
  * ======================================================
@@ -439,9 +402,8 @@ router.get('/health/check', (_req, res) => {
 
 export default router;
 `;
-fs.writeFileSync(path.join(basePath, `${fileName}.routes.ts`), routesContent);
-const dtoContent = `import { ApiResponse, PaginatedData } from "../common/common.dto";
-
+    fs.writeFileSync(path.join(basePath, `${fileName}.routes.ts`), routesContent);
+    const dtoContent = `
 /**
  * Main ${ModuleClassName} entity
  *
@@ -614,10 +576,114 @@ export interface Get${ModuleClassName}ResponseDto
  */
 export interface List${ModuleClassName}ResponseDto
   extends ApiResponse<PaginatedData<Partial<${ModuleClassName}>>> {}
+      
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     PaginationRequestDto:
+ *       type: object
+ *       properties:
+ *         offset:
+ *           type: integer
+ *           example: 0
+ *           minimum: 0
+ *           description: Number of records to skip
+ *         limit:
+ *           type: integer
+ *           example: 10
+ *           minimum: 1
+ *           maximum: 100
+ *           description: Number of records to return
+ *         search:
+ *           type: string
+ *           example: laptop
+ *           description: Search keyword (optional)
+ *         sortBy:
+ *           type: string
+ *           example: createdAt
+ *           description: Field to sort by
+ *         sortOrder:
+ *           type: string
+ *           enum: [asc, desc]
+ *           example: desc
+ *           description: Sorting order
+ */
+export interface PaginationRequestDto {
+  offset?: number;
+  limit?: number;
+  search?: string;
+  sortBy?: string;
+  sortOrder?: "asc" | "desc";
+}
+
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     ApiResponse:
+ *       type: object
+ *       properties:
+ *         success:
+ *           type: boolean
+ *           example: true
+ *           description: Operation success status
+ *         status:
+ *           type: integer
+ *           example: 200
+ *           description: HTTP status code
+ *         message:
+ *           type: string
+ *           example: Request successful
+ *           description: Response message
+ *         data:
+ *           type: object
+ *           nullable: true
+ *           description: Response data (optional, can be any type)
+ */
+export interface ApiResponse<T = any> {
+  success: boolean;
+  status: number;
+  message: string;
+  data?: T;
+}
+
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     PaginatedData:
+ *       type: object
+ *       properties:
+ *         items:
+ *           type: array
+ *           description: List of paginated items
+ *           items:
+ *             type: object
+ *         total:
+ *           type: integer
+ *           example: 120
+ *           description: Total number of records
+ *         offset:
+ *           type: integer
+ *           example: 0
+ *           description: Starting index of the current page
+ *         limit:
+ *           type: integer
+ *           example: 10
+ *           description: Number of items per page
+ */
+export interface PaginatedData<T> {
+  items: T[];
+  total: number;
+  offset: number;
+  limit: number;
+}
+
 `;
-fs.writeFileSync(path.join(basePath, `${fileName}.dto.ts`), dtoContent);
-// Middleware
-const middlewareContent = `
+    fs.writeFileSync(path.join(basePath, `${fileName}.dto.ts`), dtoContent);
+    // Middleware
+    const middlewareContent = `
 import { Request, Response, NextFunction } from "express";
 import { cacheService } from "../../utils/redis";
 import { CachedUserProfilePermissionDto } from "../../utils/redis.dto";
@@ -668,10 +734,6 @@ export async function ${moduleName}Middleware(req: Request, res: Response, next:
   }
 }
 `;
-fs.writeFileSync(path.join(basePath, `${fileName}.middlewares.ts`), middlewareContent);
-const routerIndexPath = path.join(projectRoot, "src", "routes.ts");
-if (fs.existsSync(routerIndexPath)) {
-    fs.appendFileSync(routerIndexPath, `\nimport ${moduleName}Routes from "./modules/${fileName}/${fileName}.routes";`);
-    fs.appendFileSync(routerIndexPath, `\nrouter.use("/${moduleName}", ${moduleName}Routes);\n`);
+    fs.writeFileSync(path.join(basePath, `${fileName}.middlewares.ts`), middlewareContent);
+    console.log(`Module '${moduleName}' generated successfully at ${basePath}`);
 }
-console.log(`Module '${moduleName}' generated successfully at ${basePath}`);

package/dist/scripts/generate-root-files.js

@@ -1,13 +1,6 @@
-// scripts/generate-root-files.ts
 import * as fs from "fs";
 import * as path from "path";
-import * as readline from "readline";
-const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-});
-rl.question("Enter project name: ", (projectName) => {
-    /* ================= tsconfig.json ================= */
+export function generateRootFiles(projectDir, projectName) {
     const tsconfig = {
         compilerOptions: {
             module: "nodenext",
@@ -35,89 +28,232 @@ rl.question("Enter project name: ", (projectName) => {
         },
         include: ["src", "server.ts", "prisma.config.ts"],
         exclude: ["node_modules"],
-        assets: ["src/locales"],
     };
-    fs.writeFileSync(path.join(process.cwd(), "tsconfig.json"), JSON.stringify(tsconfig, null, 2));
-    /* ================= package.json ================= */
+    fs.writeFileSync(path.join(projectDir, "tsconfig.json"), JSON.stringify(tsconfig, null, 2));
     const packageJson = {
         name: projectName.toLowerCase().replace(/\s+/g, "-"),
-        version: "1.0.0",
-        description: `${projectName} backend.`,
-        license: "ISC",
-        author: "abir-hosen",
-        main: "server.ts",
-        scripts: {
-            "copy-locales": 'cpx "src/locales/**/*" dist/src/locales',
-            dev: "nodemon",
-            build: "tsc && npm run copy-locales",
-            start: "node dist/server.js",
-            "generate-module": "ts-node scripts/generate-module.ts",
-            "generate-middlewares": "ts-node scripts/middleware.ts",
-            "generate-locales": "ts-node scripts/generate-locales.ts",
-            "generate-utils": "ts-node scripts/generate-utils.ts"
+        "version": "1.0.0",
+        "description": "Cryptdox generated expressJS backend.",
+        "keywords": [
+            "ts"
+        ],
+        "homepage": "https://github.com/..#readme",
+        "bugs": {
+            "url": "https://github.com/../issues"
+        },
+        "repository": {
+            "type": "git",
+            "url": "git+https://github.com/...git"
+        },
+        "license": "ISC",
+        "author": "abir-hosen",
+        "main": "server.ts",
+        "scripts": {
+            "copy-locales": "cpx \"src/locales/**/*\" dist/src/locales",
+            "dev": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' server.ts",
+            "build": "tsc && npm run copy-locales",
+            "start": "node dist/server.js",
+            "test": "echo \"Error: no test specified\" && exit 1",
+            "generate-module": "ts-node scripts/generate-module.ts"
         },
+        "dependencies": {
+            "@prisma/adapter-pg": "^7.3.0",
+            "@prisma/client": "^7.3.0",
+            "acorn": "^8.15.0",
+            "acorn-walk": "^8.3.4",
+            "arg": "^4.1.3",
+            "bcrypt": "^6.0.0",
+            "cors": "^2.8.6",
+            "create-require": "^1.1.1",
+            "diff": "^4.0.4",
+            "dotenv": "^17.2.3",
+            "express": "^5.2.1",
+            "i18next": "^25.8.4",
+            "i18next-fs-backend": "^2.6.1",
+            "i18next-http-middleware": "^3.9.2",
+            "jsonwebtoken": "^9.0.3",
+            "make-error": "^1.3.6",
+            "morgan": "^1.10.1",
+            "pg": "^8.18.0",
+            "redis": "^5.11.0",
+            "swagger-jsdoc": "^6.2.8",
+            "swagger-ui-express": "^5.0.1",
+            "undici-types": "^7.16.0",
+            "v8-compile-cache-lib": "^3.0.1",
+            "winston": "^3.19.0",
+            "yn": "^3.1.1",
+            "zod": "^4.3.6"
+        },
+        "devDependencies": {
+            "@types/bcrypt": "^6.0.0",
+            "@types/cors": "^2.8.19",
+            "@types/express": "^5.0.6",
+            "@types/i18next": "^12.1.0",
+            "@types/jsonwebtoken": "^9.0.10",
+            "@types/morgan": "^1.9.10",
+            "@types/node": "^25.1.0",
+            "@types/swagger-jsdoc": "^6.0.4",
+            "@types/swagger-ui-express": "^4.1.8",
+            "cpx": "^1.5.0",
+            "nodemon": "^3.1.11",
+            "prisma": "^7.3.0",
+            "ts-node": "^10.9.2",
+            "typescript": "^5.9.3"
+        }
     };
-    fs.writeFileSync(path.join(process.cwd(), "package.json"), JSON.stringify(packageJson, null, 2));
-    /* ================= nodemon.json ================= */
+    fs.writeFileSync(path.join(projectDir, "package.json"), JSON.stringify(packageJson, null, 2));
     const nodemon = {
         watch: ["src"],
         ext: "ts",
         ignore: ["dist"],
-        exec: "ts-node src/server.ts",
+        exec: "ts-node server.ts",
     };
-    fs.writeFileSync(path.join(process.cwd(), "nodemon.json"), JSON.stringify(nodemon, null, 2));
-    /* ================= .gitignore ================= */
+    fs.writeFileSync(path.join(projectDir, "nodemon.json"), JSON.stringify(nodemon, null, 2));
     const gitignore = `
 node_modules
-/src/generated/prisma
 .env
-package-lock.json
 dist
+package-lock.json
 pnpm-lock.yaml
-/generated/prisma
-`;
-    fs.writeFileSync(path.join(process.cwd(), ".gitignore"), gitignore.trim());
-    /* ================= .prisma ================= */
-    const prisma = `
+  `;
+    fs.writeFileSync(path.join(projectDir, ".gitignore"), gitignore.trim());
+    generatePrisma(projectDir);
+    generatePrismaConfig(projectDir);
+    generateEnvironmentAndDocker(projectDir);
+    console.log(`✅ root config files generated for project: ${projectName}`);
+}
+/* ================= PRISMA ================= */
+function generatePrisma(projectDir) {
+    const prismaDir = path.join(projectDir, "prisma");
+    if (!fs.existsSync(prismaDir))
+        fs.mkdirSync(prismaDir, { recursive: true });
+    const schema = `
 // This is your Prisma schema file,
 // learn more about it in the docs: https://pris.ly/d/prisma-schema
 
 // Looking for ways to speed up your queries, or scale easily with your serverless or edge functions?
 // Try Prisma Accelerate: https://pris.ly/cli/accelerate-init
 
-  generator client {
-    provider = "prisma-client-js"
-  }
-  
-  datasource db {
-    provider = "postgresql"
-  }
-  
-  model Common {
-    commonId      String        @id @default(uuid())
-    name         String        @unique
-  }
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgresql"
+}
+
+model Common {
+  commonId String @id @default(uuid())
+  name     String @unique
+}
 `;
-    fs.writeFileSync(path.join(process.cwd(), "prisma", "schema.prisma"), prisma.trim());
-    /* ================= .prisma ================= */
-    const prismaConfig = `
+    fs.writeFileSync(path.join(prismaDir, "schema.prisma"), schema.trim());
+}
+/* ================= PRISMA CONFIG ================= */
+function generatePrismaConfig(projectDir) {
+    const config = `
 // This file was generated by Prisma, and assumes you have installed the following:
 // npm install --save-dev prisma dotenv
+
 import "dotenv/config";
 import { defineConfig } from "prisma/config";
 
 export default defineConfig({
   schema: "prisma/schema.prisma",
-  migrations: {
-    path: "prisma/migrations",
-  },
-  datasource: {
-    url: process.env["DATABASE_URL"],
-  },
+  migrations: { path: "prisma/migrations" },
+  datasource: { url: process.env["DATABASE_URL"] },
 });
+  `;
+    fs.writeFileSync(path.join(projectDir, "prisma.config.ts"), config.trim());
+}
+/* ================= ENV & DOCKER CONFIG ================= */
+function generateEnvironmentAndDocker(projectDir) {
+    /* ================= ENV FILES ================= */
+    const baseEnv = `
+PORT=3000
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/app_db
+REDIS_URL=redis://localhost:6379
+`.trim();
+    const envDev = `
+PORT=3000
+DATABASE_URL=postgresql://postgres:postgres@postgres:5432/app_db
+REDIS_URL=redis://redis:6379
+`.trim();
+    const envProd = `
+PORT=3000
+DATABASE_URL=postgresql://postgres:strongpassword@postgres:5432/app_db
+REDIS_URL=redis://redis:6379
+`.trim();
+    const exampleEnv = `
+PORT=
+DATABASE_URL=
+REDIS_URL=
+`.trim();
+    fs.writeFileSync(path.join(projectDir, ".env"), baseEnv);
+    fs.writeFileSync(path.join(projectDir, ".env.local"), baseEnv);
+    fs.writeFileSync(path.join(projectDir, ".env.dev"), envDev);
+    fs.writeFileSync(path.join(projectDir, ".env.prod"), envProd);
+    fs.writeFileSync(path.join(projectDir, "example.env"), exampleEnv);
+    /* ================= DOCKERFILE ================= */
+    const dockerfile = `
+FROM node:20-alpine
 
-`;
-    fs.writeFileSync(path.join(process.cwd(), "prisma.config.ts"), prismaConfig.trim());
-    console.log(`✅ Root config files generated for project: ${projectName}`);
-    rl.close();
-});
+WORKDIR /app
+
+COPY package.json pnpm-lock.yaml* ./
+
+RUN npm install -g pnpm
+RUN pnpm install
+
+COPY . .
+
+RUN pnpm build
+
+EXPOSE 3000
+
+CMD ["node", "dist/server.js"]
+`.trim();
+    fs.writeFileSync(path.join(projectDir, "Dockerfile"), dockerfile);
+    /* ================= DOCKER COMPOSE ================= */
+    const dockerCompose = `
+version: "3.9"
+
+services:
+  app:
+    build: .
+    container_name: express_app
+    ports:
+      - "3000:3000"
+    env_file:
+      - .env.dev
+    depends_on:
+      - postgres
+      - redis
+    restart: always
+
+  postgres:
+    image: postgres:16
+    container_name: postgres_db
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: app_db
+    ports:
+      - "5432:5432"
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    restart: always
+
+  redis:
+    image: redis:7
+    container_name: redis_cache
+    ports:
+      - "6379:6379"
+    restart: always
+
+volumes:
+  pgdata:
+`.trim();
+    fs.writeFileSync(path.join(projectDir, "docker-compose.yml"), dockerCompose);
+    console.log("✅ ENV and Docker files generated");
+}