create-flex-stack 1.0.0

package/dist/templates/sharedTemplate.js

@@ -0,0 +1,654 @@
+function toPackageName(name) {
+    const normalized = name
+        .toLowerCase()
+        .replace(/[^a-z0-9._-]+/g, '-')
+        .replace(/^[._-]+/, '')
+        .replace(/[._-]+$/, '');
+    return normalized || 'app';
+}
+export function getTsConfig(options) {
+    const decorators = options.orm === 'typeorm'
+        ? `,\n    "experimentalDecorators": true,\n    "emitDecoratorMetadata": true,\n    "strictPropertyInitialization": false`
+        : '';
+    return `{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true${decorators}
+  },
+  "include": ["src/**/*"]
+}`;
+}
+export function getGitIgnore() {
+    return `# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Dist / Build
+dist/
+build/
+.tsbuildinfo
+
+# Environment variables
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# IDEs and editors
+.idea/
+.vscode/
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Uploads
+uploads/
+`;
+}
+export function getDockerFiles(options) {
+    const isPrisma = options.orm === 'prisma';
+    const composeDatabaseUrl = options.database === 'postgres'
+        ? 'postgresql://postgres:password@db:5432/${PROJECT_NAME}?schema=public'
+        : options.database === 'mysql'
+            ? 'mysql://user:password@db:3306/${PROJECT_NAME}'
+            : options.database === 'mongodb'
+                ? 'mongodb://db:27017/${PROJECT_NAME}'
+                : '${DATABASE_URL}';
+    const dbService = options.database === 'postgres'
+        ? `  db:
+    image: postgres:15-alpine
+    container_name: \${PROJECT_NAME}-db
+    restart: always
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: \${PROJECT_NAME}
+    ports:
+      - "5432:5432"
+    volumes:
+      - pgdata:/var/lib/postgresql/data`
+        : options.database === 'mysql'
+            ? `  db:
+    image: mysql:8
+    container_name: \${PROJECT_NAME}-db
+    restart: always
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: \${PROJECT_NAME}
+      MYSQL_USER: user
+      MYSQL_PASSWORD: password
+    ports:
+      - "3306:3306"
+    volumes:
+      - mysqldata:/var/lib/mysql`
+            : options.database === 'mongodb'
+                ? `  db:
+    image: mongo:6
+    container_name: \${PROJECT_NAME}-db
+    restart: always
+    ports:
+      - "27017:27017"
+    volumes:
+      - mongodata:/data/db`
+                : ''; // No SQLite service needed in docker-compose
+    const redisService = options.caching
+        ? `\n  redis:
+    image: redis:7-alpine
+    container_name: \${PROJECT_NAME}-redis
+    restart: always
+    ports:
+      - "6379:6379"`
+        : '';
+    let volumes = '';
+    if (options.database === 'postgres') {
+        volumes = `volumes:\n  pgdata:`;
+    }
+    else if (options.database === 'mysql') {
+        volumes = `volumes:\n  mysqldata:`;
+    }
+    else if (options.database === 'mongodb') {
+        volumes = `volumes:\n  mongodata:`;
+    }
+    const dockerfile = isPrisma
+        ? `FROM node:20-slim AS builder
+WORKDIR /usr/src/app
+
+RUN apt-get update -y && apt-get install -y openssl ca-certificates && rm -rf /var/lib/apt/lists/*
+
+COPY package*.json ./
+RUN npm ci
+COPY . .
+RUN npx prisma generate
+RUN npm run build
+
+FROM node:20-slim
+WORKDIR /usr/src/app
+
+RUN apt-get update -y && apt-get install -y openssl ca-certificates && rm -rf /var/lib/apt/lists/*
+
+COPY package*.json ./
+RUN npm ci --omit=dev
+COPY --from=builder /usr/src/app/dist ./dist
+COPY --from=builder /usr/src/app/prisma ./prisma
+COPY --from=builder /usr/src/app/node_modules/.prisma ./node_modules/.prisma
+
+EXPOSE 3000
+CMD ["node", "dist/server.js"]
+`
+        : `FROM node:20-slim AS builder
+WORKDIR /usr/src/app
+
+COPY package*.json ./
+RUN npm ci
+COPY . .
+RUN npm run build
+
+FROM node:20-slim
+WORKDIR /usr/src/app
+
+COPY package*.json ./
+RUN npm ci --omit=dev
+COPY --from=builder /usr/src/app/dist ./dist
+
+EXPOSE 3000
+CMD ["node", "dist/server.js"]
+`;
+    const dockerCompose = `version: '3.8'
+
+services:
+  app:
+    build: .
+    container_name: \${PROJECT_NAME}-app
+    ports:
+      - "\${PORT:-3000}:\${PORT:-3000}"
+    env_file:
+      - .env
+    environment:
+      - NODE_ENV=production
+      - PORT=\${PORT:-3000}
+      - DATABASE_URL=${composeDatabaseUrl}
+      ${options.auth ? `- JWT_SECRET=\${JWT_SECRET}
+      - JWT_REFRESH_SECRET=\${JWT_REFRESH_SECRET}` : ''}
+      ${options.caching ? '- REDIS_URL=redis://redis:6379' : ''}
+    depends_on:
+      ${dbService ? '- db' : ''}
+      ${options.caching ? '- redis' : ''}
+
+${dbService}${redisService}
+
+${volumes}
+`;
+    return { dockerfile, dockerCompose };
+}
+export function getDotEnv(options) {
+    let dbUrl = '';
+    if (options.database === 'postgres') {
+        dbUrl = 'postgresql://postgres:password@localhost:5432/' + options.projectName + '?schema=public';
+    }
+    else if (options.database === 'mysql') {
+        dbUrl = 'mysql://user:password@localhost:3306/' + options.projectName;
+    }
+    else if (options.database === 'sqlite') {
+        dbUrl = 'file:./dev.db';
+    }
+    else if (options.database === 'mongodb') {
+        dbUrl = 'mongodb://localhost:27017/' + options.projectName;
+    }
+    let env = `PROJECT_NAME="${toPackageName(options.projectName)}"
+PORT=3000
+NODE_ENV=development
+DATABASE_URL="${dbUrl}"
+`;
+    if (options.auth) {
+        env += `JWT_SECRET="super-secret-key-change-me-in-production"
+JWT_REFRESH_SECRET="super-secret-refresh-key-change-me-in-production"
+JWT_EXPIRES_IN="15m"
+JWT_REFRESH_EXPIRES_IN="7d"
+`;
+    }
+    if (options.caching) {
+        env += `REDIS_URL="redis://localhost:6379"
+`;
+    }
+    return env;
+}
+export function getReadme(options) {
+    const architectureName = options.architecture === 'clean'
+        ? 'Clean Architecture'
+        : options.architecture === 'hexagonal'
+            ? 'Hexagonal Architecture (Ports & Adapters)'
+            : options.architecture === 'modular'
+                ? 'Modular Feature-based Architecture'
+                : options.architecture === 'vmc'
+                    ? 'VMC Architecture (View, Model, Controller)'
+                    : 'Layered Architecture (MVC)';
+    const prismaSection = options.orm === 'prisma'
+        ? `## Prisma
+
+Prisma needs a generated client before the app can import \`@prisma/client\`.
+
+Development:
+\`\`\`bash
+npm run db:generate
+npm run db:push
+\`\`\`
+
+Production or Docker release flow:
+\`\`\`bash
+npm run db:generate
+npm run db:migrate:deploy
+\`\`\`
+
+Equivalent direct Prisma commands:
+\`\`\`bash
+npx prisma generate
+npx prisma migrate deploy
+\`\`\`
+
+Useful local tools:
+\`\`\`bash
+npx prisma studio
+\`\`\`
+`
+        : '';
+    const dockerSection = options.docker
+        ? `## Docker
+
+The generated \`Dockerfile\` uses \`node:20-slim\` and installs \`openssl\` plus CA certificates so Prisma engines work reliably in containers.
+
+\`\`\`bash
+docker compose up --build
+\`\`\`
+
+Make sure \`.env\` contains \`PROJECT_NAME\`, \`PORT\`, and \`DATABASE_URL\`. The compose file reads \`.env\` via \`env_file\`.
+`
+        : '';
+    const swaggerSection = options.swagger
+        ? `## API Documentation
+
+Swagger UI is mounted at:
+
+\`\`\`text
+http://localhost:3000/docs
+\`\`\`
+
+The OpenAPI document includes the user endpoints generated for this project.
+`
+        : '';
+    const testingSection = options.testing
+        ? `## Tests
+
+Tests live in \`tests/\`.
+
+\`\`\`bash
+npm test
+\`\`\`
+`
+        : '';
+    return `# ${options.projectName}
+
+Created with create-flex-stack. This project uses **${architectureName}** built with **ExpressJS + TypeScript**${options.frontend ? ' and a React frontend client' : ''}.
+
+## Technologies
+- **Backend Framework**: ExpressJS
+- **Database**: ${options.database}
+- **ORM / ODM**: ${options.orm}
+- **Validation**: ${options.validation}
+${options.auth ? '- **Auth**: JWT Authentication & Refresh Tokens' : ''}
+${options.fileUpload ? '- **File Upload**: Configured with Multer' : ''}
+${options.docker ? '- **Docker**: Dockerfile & docker-compose configuration' : ''}
+${options.rateLimiting ? '- **Rate Limiting**: express-rate-limit' : ''}
+${options.swagger ? '- **Swagger**: API Documentation' : ''}
+${options.caching ? '- **Caching**: Redis Cache Layer' : ''}
+${options.rbac ? '- **RBAC**: Role-Based Access Control' : ''}
+${options.testing ? '- **Testing**: Jest unit & integration testing' : ''}
+
+## Project Structure
+
+${options.frontend ? `- \`backend/\`: Express API
+- \`frontend/\`: React client
+- \`docker-compose.yml\`: local container orchestration` : `- \`src/\`: application source code
+- \`prisma/\`: Prisma schema and migrations when Prisma is selected
+- \`tests/\`: Jest tests when testing is enabled`}
+
+## Getting Started
+
+### Installation
+Install dependencies:
+\`\`\`bash
+npm install
+\`\`\`
+
+Configure environment variables in \`.env\`.
+
+${options.orm !== 'prisma' ? 'Ensure your selected database is running before starting the API.' : ''}
+
+### Development
+\`\`\`bash
+npm run dev
+\`\`\`
+
+### Build
+\`\`\`bash
+npm run build
+\`\`\`
+
+### Production Start
+\`\`\`bash
+npm start
+\`\`\`
+
+${prismaSection}
+${dockerSection}
+${swaggerSection}
+${testingSection}
+`;
+}
+export function getRootPackageJson(projectName) {
+    const packageName = toPackageName(projectName);
+    const pkg = {
+        name: packageName,
+        version: "1.0.0",
+        private: true,
+        workspaces: [
+            "backend",
+            "frontend"
+        ],
+        scripts: {
+            "dev": "concurrently \"npm run dev --workspace=backend\" \"npm run dev --workspace=frontend\"",
+            "build": "npm run build --workspace=backend && npm run build --workspace=frontend",
+            "start": "npm start --workspace=backend",
+            "test": "npm test --workspace=backend"
+        },
+        dependencies: {
+            "concurrently": "^8.2.2"
+        }
+    };
+    return JSON.stringify(pkg, null, 2);
+}
+export function getPackageJson(options) {
+    const packageName = toPackageName(options.projectName);
+    const dependencies = {
+        "express": "^4.19.2",
+        "cors": "^2.8.5",
+        "dotenv": "^16.4.5",
+        "helmet": "^7.1.0"
+    };
+    const devDependencies = {
+        "typescript": "^5.4.5",
+        "@types/node": "^20.12.7",
+        "@types/express": "^4.17.21",
+        "@types/cors": "^2.8.17",
+        "tsx": "^4.7.2",
+        "nodemon": "^3.1.0"
+    };
+    // ORM Specifics
+    if (options.orm === 'prisma') {
+        dependencies["@prisma/client"] = "^5.12.1";
+        devDependencies["prisma"] = "^5.12.1";
+    }
+    else if (options.orm === 'mongoose') {
+        dependencies["mongoose"] = "^8.3.1";
+    }
+    else if (options.orm === 'typeorm') {
+        dependencies["typeorm"] = "^0.3.20";
+        dependencies["reflect-metadata"] = "^0.2.2";
+        if (options.database === 'postgres') {
+            dependencies["pg"] = "^8.11.5";
+            devDependencies["@types/pg"] = "^8.11.5";
+        }
+        else if (options.database === 'mysql') {
+            dependencies["mysql2"] = "^3.9.7";
+        }
+        else if (options.database === 'sqlite') {
+            dependencies["sqlite3"] = "^5.1.7";
+        }
+    }
+    // Auth Specifics
+    if (options.auth) {
+        dependencies["jsonwebtoken"] = "^9.0.2";
+        dependencies["bcryptjs"] = "^2.4.3";
+        devDependencies["@types/jsonwebtoken"] = "^9.0.6";
+        devDependencies["@types/bcryptjs"] = "^2.4.6";
+    }
+    // Validation
+    if (options.validation === 'zod') {
+        dependencies["zod"] = "^3.22.4";
+    }
+    else if (options.validation === 'joi') {
+        dependencies["joi"] = "^17.12.3";
+        devDependencies["@types/joi"] = "^17.2.3";
+    }
+    // Optional modules
+    if (options.rateLimiting) {
+        dependencies["express-rate-limit"] = "^7.2.0";
+    }
+    if (options.swagger) {
+        dependencies["swagger-ui-express"] = "^5.0.0";
+        devDependencies["@types/swagger-ui-express"] = "^4.1.6";
+    }
+    if (options.caching) {
+        dependencies["redis"] = "^4.6.13";
+    }
+    if (options.fileUpload) {
+        dependencies["multer"] = "^2.2.0";
+        devDependencies["@types/multer"] = "^1.4.11";
+    }
+    // Testing setup (Jest)
+    if (options.testing) {
+        devDependencies["jest"] = "^29.7.0";
+        devDependencies["ts-jest"] = "^29.1.2";
+        devDependencies["supertest"] = "^6.3.4";
+        devDependencies["@types/jest"] = "^29.5.12";
+        devDependencies["@types/supertest"] = "^6.0.2";
+    }
+    const packageJson = {
+        name: `${packageName}-backend`,
+        version: "1.0.0",
+        description: `Express backend built with ${options.architecture} architecture`,
+        main: "dist/server.js",
+        type: "module",
+        scripts: {
+            "build": "tsc",
+            "start": "node dist/server.js",
+            "dev": "nodemon --watch src --ext ts --exec tsx src/server.ts",
+            "db:generate": options.orm === 'prisma' ? "npx prisma generate" : "echo 'No db:generate script needed'",
+            "db:push": options.orm === 'prisma' ? "npx prisma db push" : "echo 'No db:push script needed'",
+            "db:migrate:deploy": options.orm === 'prisma' ? "npx prisma migrate deploy" : "echo 'No db:migrate:deploy script needed'",
+            "test": options.testing ? "node --experimental-vm-modules node_modules/jest/bin/jest.js --passWithNoTests" : "echo 'No tests configured'"
+        },
+        dependencies,
+        devDependencies
+    };
+    return JSON.stringify(packageJson, null, 2);
+}
+export function getPrismaSchema(options) {
+    let provider = 'postgresql';
+    if (options.database === 'mysql')
+        provider = 'mysql';
+    if (options.database === 'sqlite')
+        provider = 'sqlite';
+    if (options.database === 'mongodb')
+        provider = 'mongodb';
+    let schema = `datasource db {
+  provider = "${provider}"
+  url      = env("DATABASE_URL")
+}
+
+generator client {
+  provider = "prisma-client-js"
+}
+`;
+    schema += `\nmodel User {
+  id           String   @id @default(${provider === 'mongodb' ? 'auto()' : 'uuid()'}) ${provider === 'mongodb' ? '@map("_id") @db.ObjectId' : ''}
+  email        String   @unique
+  name         String?
+${options.auth ? `  password     String
+  role         String   @default("user")` : `  role         String?`}
+  createdAt    DateTime @default(now())
+  updatedAt    DateTime @updatedAt
+${options.auth ? `  refreshToken String?` : ''}
+}
+`;
+    return schema;
+}
+export function getAuthenticatedPrismaUserModel(options) {
+    let provider = 'postgresql';
+    if (options.database === 'mysql')
+        provider = 'mysql';
+    if (options.database === 'sqlite')
+        provider = 'sqlite';
+    if (options.database === 'mongodb')
+        provider = 'mongodb';
+    return `model User {
+  id           String   @id @default(${provider === 'mongodb' ? 'auto()' : 'uuid()'}) ${provider === 'mongodb' ? '@map("_id") @db.ObjectId' : ''}
+  email        String   @unique
+  name         String?
+  password     String
+  role         String   @default("user")
+  createdAt    DateTime @default(now())
+  updatedAt    DateTime @updatedAt
+  refreshToken String?
+}
+`;
+}
+export function getMulterMiddleware() {
+    return `import multer from 'multer';
+import path from 'path';
+import fs from 'fs';
+import { AppError } from './errorHandler.js'; // Fallback path
+
+const uploadDir = path.resolve(process.cwd(), 'uploads');
+if (!fs.existsSync(uploadDir)) {
+  fs.mkdirSync(uploadDir, { recursive: true });
+}
+
+const storage = multer.diskStorage({
+  destination: (req, file, cb) => {
+    cb(null, uploadDir);
+  },
+  filename: (req, file, cb) => {
+    const uniqueSuffix = Date.now() + '-' + Math.round(Math.random() * 1e9);
+    cb(null, file.fieldname + '-' + uniqueSuffix + path.extname(file.originalname));
+  }
+});
+
+const fileFilter = (req: any, file: any, cb: any) => {
+  // Allow images and documents
+  const allowedTypes = ['.png', '.jpg', '.jpeg', '.pdf', '.docx', '.txt'];
+  const ext = path.extname(file.originalname).toLowerCase();
+  if (allowedTypes.includes(ext)) {
+    cb(null, true);
+  } else {
+    cb(new AppError(400, 'Invalid file type. Only PNG, JPG, PDF, DOCX, TXT allowed.'));
+  }
+};
+
+export const upload = multer({
+  storage,
+  fileFilter,
+  limits: {
+    fileSize: 5 * 1024 * 1024 // 5 MB limit
+  }
+});
+`;
+}
+export function getTypeOrmConfig(options) {
+    let type = 'postgres';
+    if (options.database === 'mysql')
+        type = 'mysql';
+    if (options.database === 'sqlite')
+        type = 'sqlite';
+    const databaseLine = type === 'sqlite' ? '  database: "dev.db",' : '  url: process.env.DATABASE_URL,';
+    return `import "reflect-metadata";
+import { DataSource } from "typeorm";
+import { UserEntity } from "../entities/user.entity.js"; // Fallback path
+
+export const AppDataSource = new DataSource({
+  type: "${type}",
+${databaseLine}
+  synchronize: true, // Auto-create tables in development
+  logging: false,
+  entities: [UserEntity],
+  migrations: [],
+  subscribers: [],
+});
+`;
+}
+export function getTypeOrmEntity() {
+    return `import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn } from "typeorm";
+
+@Entity({ name: "users" })
+export class UserEntity {
+  @PrimaryGeneratedColumn("uuid")
+  id!: string;
+
+  @Column({ unique: true })
+  email!: string;
+
+  @Column({ nullable: true })
+  name?: string;
+
+  @Column()
+  password!: string;
+
+  @Column({ default: "user" })
+  role!: string;
+
+  @Column({ nullable: true })
+  refreshToken?: string;
+
+  @CreateDateColumn()
+  createdAt!: Date;
+
+  @UpdateDateColumn()
+  updatedAt!: Date;
+}
+`;
+}
+export function getJestConfig() {
+    return `{
+  "preset": "ts-jest",
+  "testEnvironment": "node",
+  "testPathIgnorePatterns": ["/node_modules/", "/dist/"],
+  "extensionsToTreatAsEsm": [".ts"],
+  "moduleNameMapper": {
+    "^(\\\\.{1,2}/.*)\\\\.js$": "$1"
+  },
+  "transform": {
+    "^.+\\\\.tsx?$": [
+      "ts-jest",
+      {
+        "useESM": true
+      }
+    ]
+  }
+}`;
+}

package/dist/templates/vmcTemplate.js

@@ -0,0 +1,26 @@
+import { getLayeredFiles } from './layeredTemplate.js';
+export function getVmcFiles(options) {
+    const layeredFiles = getLayeredFiles(options);
+    const files = {};
+    for (const [filePath, originalContent] of Object.entries(layeredFiles)) {
+        let targetPath = filePath
+            .replace('src/schemas/user.schema.ts', 'src/view/user.view.ts')
+            .replace('src/repositories/user.repository.ts', 'src/model/user.repository.ts')
+            .replace('src/models/user.model.ts', 'src/model/user.model.ts')
+            .replace('src/services/user.service.ts', 'src/model/user.model-service.ts')
+            .replace('src/controllers/user.controller.ts', 'src/controller/user.controller.ts');
+        let content = originalContent
+            .replaceAll('../repositories/user.repository.js', '../model/user.repository.js')
+            .replaceAll('../models/user.model.js', './user.model.js')
+            .replaceAll('../services/user.service.js', '../model/user.model-service.js')
+            .replaceAll('../controllers/user.controller.js', '../controller/user.controller.js')
+            .replaceAll('../schemas/user.schema.js', '../view/user.view.js')
+            .replaceAll('Traditional Layered', 'VMC')
+            .replaceAll('Layered Architecture', 'VMC Architecture');
+        if (targetPath === 'src/model/user.repository.ts') {
+            content = content.replaceAll('../models/user.model.js', './user.model.js');
+        }
+        files[targetPath] = content;
+    }
+    return files;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};