create-xpress-backend 1.0.0

package/src/templates/ts.js

@@ -0,0 +1,587 @@
+'use strict';
+
+const { buildSharedFiles, buildReadme } = require('./shared');
+
+function buildTsTemplates({ projectName, port, includeFileUpload, includeAuth }) {
+  const files = {};
+
+  // ─── package.json ─────────────────────────────────────────────────────────
+  const deps = {
+    '@prisma/adapter-pg': '^7.3.0',
+    '@prisma/client': '^7.3.0',
+    '@prisma/config': '^7.3.0',
+    bcryptjs: '^3.0.2',
+    cors: '^2.8.5',
+    dotenv: '^17.2.3',
+    express: '^4.21.2',
+    helmet: '^8.1.0',
+    joi: '^18.0.1',
+    jsonwebtoken: '^9.0.2',
+    morgan: '^1.10.1',
+    pg: '^8.18.0',
+  };
+  if (includeFileUpload) deps['multer'] = '^2.0.2';
+
+  const devDeps = {
+    '@types/bcryptjs': '^2.4.6',
+    '@types/cors': '^2.8.17',
+    '@types/express': '^5.0.0',
+    '@types/jsonwebtoken': '^9.0.6',
+    '@types/morgan': '^1.9.9',
+    '@types/node': '^20.14.0',
+    '@types/pg': '^8.11.6',
+    'ts-node-dev': '^2.0.0',
+    typescript: '^5.4.5',
+    prisma: '^7.3.0',
+  };
+  if (includeFileUpload) devDeps['@types/multer'] = '^1.4.11';
+
+  files['package.json'] = JSON.stringify({
+    name: projectName,
+    version: '1.0.0',
+    description: '',
+    main: 'dist/server.js',
+    scripts: {
+      dev: 'ts-node-dev --respawn --transpile-only src/server.ts',
+      build: 'tsc',
+      start: 'node dist/server.js',
+      'db:generate': 'prisma generate',
+      'db:push': 'prisma db push',
+      'db:reset': 'prisma db push --force-reset',
+      'db:seed': 'ts-node-dev --transpile-only src/database/seed.ts',
+      'db:studio': 'prisma studio',
+      'db:dev': 'prisma db push && prisma generate',
+    },
+    keywords: [],
+    author: {
+      name: 'ayushsolanki29',
+      url: 'https://github.com/ayushsolanki29',
+    },
+    license: 'MIT',
+    homepage: 'https://github.com/ayushsolanki29/create-xpress-backend#readme',
+    repository: {
+      type: 'git',
+      url: 'https://github.com/ayushsolanki29/create-xpress-backend',
+    },
+    bugs: {
+      url: 'https://github.com/ayushsolanki29/create-xpress-backend/issues',
+    },
+    _createdWith: 'create-xpress-backend',
+    _scaffold: 'https://github.com/ayushsolanki29/create-xpress-backend',
+    dependencies: deps,
+    devDependencies: devDeps,
+  }, null, 2);
+
+  // ─── tsconfig.json ────────────────────────────────────────────────────────
+  files['tsconfig.json'] = JSON.stringify({
+    compilerOptions: {
+      target: 'ES2020',
+      module: 'commonjs',
+      lib: ['ES2020'],
+      outDir: './dist',
+      rootDir: './src',
+      strict: true,
+      esModuleInterop: true,
+      skipLibCheck: true,
+      forceConsistentCasingInFileNames: true,
+      resolveJsonModule: true,
+      declaration: true,
+      declarationMap: true,
+      sourceMap: true,
+    },
+    include: ['src/**/*'],
+    exclude: ['node_modules', 'dist'],
+  }, null, 2);
+
+  // ─── shared files (env, gitignore, prisma schema, prisma.config, seed) ────
+  Object.assign(files, buildSharedFiles({ projectName, port, includeFileUpload, includeAuth, language: 'ts' }));
+
+  // ─── src/types/express.d.ts  (augment req.user) ───────────────────────────
+  files['src/types/express.d.ts'] = `import { JwtPayload } from 'jsonwebtoken';
+
+declare global {
+  namespace Express {
+    interface Request {
+      user?: string | JwtPayload;
+    }
+  }
+}
+`;
+
+  // ─── src/database/prisma.ts ───────────────────────────────────────────────
+  files['src/database/prisma.ts'] = `// src/database/prisma.ts
+import 'dotenv/config';
+import { PrismaClient } from '@prisma/client';
+import { PrismaPg } from '@prisma/adapter-pg';
+import { Pool } from 'pg';
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+const adapter = new PrismaPg(pool);
+
+const prisma = new PrismaClient({ adapter, log: ['error', 'warn'] });
+
+export default prisma;
+`;
+
+  // ─── src/middleware/validate.ts ───────────────────────────────────────────
+  files['src/middleware/validate.ts'] = `// src/middleware/validate.ts
+import { Request, Response, NextFunction } from 'express';
+import { ObjectSchema } from 'joi';
+
+const validate =
+  (schema: ObjectSchema) =>
+  (req: Request, res: Response, next: NextFunction): void => {
+    const { error } = schema.validate(req.body);
+    if (error) {
+      res.status(400).json({ success: false, message: error.details[0].message });
+      return;
+    }
+    next();
+  };
+
+export default validate;
+`;
+
+  // ─── src/middleware/upload.ts (optional) ──────────────────────────────────
+  if (includeFileUpload) {
+    files['src/middleware/upload.ts'] = `// src/middleware/upload.ts
+import multer, { FileFilterCallback } from 'multer';
+import path from 'path';
+import fs from 'fs';
+import { Request } from 'express';
+
+const uploadDir = path.join(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 unique = Date.now() + '-' + Math.round(Math.random() * 1e9);
+    cb(null, file.fieldname + '-' + unique + path.extname(file.originalname));
+  },
+});
+
+const fileFilter = (_req: Request, file: Express.Multer.File, cb: FileFilterCallback): void => {
+  const allowed = [
+    'image/jpeg', 'image/png', 'image/gif',
+    'application/pdf', 'text/plain',
+    'application/msword',
+    'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+  ];
+  allowed.includes(file.mimetype) ? cb(null, true) : cb(new Error('Invalid file type'));
+};
+
+const upload = multer({
+  storage,
+  limits: { fileSize: (parseInt(process.env.MAX_FILE_SIZE ?? '10')) * 1024 * 1024 },
+  fileFilter,
+});
+
+export default upload;
+`;
+  }
+
+  // ─── src/middleware/auth.ts (optional) ────────────────────────────────────
+  if (includeAuth) {
+    files['src/middleware/auth.ts'] = `// src/middleware/auth.ts
+import { Request, Response, NextFunction } from 'express';
+import jwt from 'jsonwebtoken';
+
+const authMiddleware = (req: Request, res: Response, next: NextFunction): void => {
+  const header = req.headers.authorization;
+  if (!header || !header.startsWith('Bearer ')) {
+    res.status(401).json({ success: false, message: 'No token provided' });
+    return;
+  }
+  const token = header.split(' ')[1];
+  try {
+    req.user = jwt.verify(token, process.env.JWT_SECRET as string);
+    next();
+  } catch {
+    res.status(401).json({ success: false, message: 'Invalid or expired token' });
+  }
+};
+
+export default authMiddleware;
+`;
+  }
+
+  // ─── src/app.ts ───────────────────────────────────────────────────────────
+  files['src/app.ts'] = `import express, { Request, Response, NextFunction } from 'express';
+import cors from 'cors';
+import helmet from 'helmet';
+import morgan from 'morgan';
+import path from 'path';
+import router from './modules';
+
+const app = express();
+
+const CLIENT_URL = process.env.CLIENT_URL ?? '*';
+
+app.set('trust proxy', 1);
+app.use(helmet());
+app.use(cors({ origin: CLIENT_URL, credentials: true }));
+app.use(morgan('dev'));
+app.use(express.json({ limit: '10mb' }));
+app.use(express.urlencoded({ extended: true }));
+${includeFileUpload ? `\napp.use('/uploads', express.static(path.join(__dirname, '../uploads')));\n` : ''}
+app.use('/api', router);
+
+app.get('/health', (_req: Request, res: Response) => {
+  res.status(200).json({
+    status: 'OK',
+    message: 'API Running ✅',
+    timestamp: new Date().toISOString(),
+    uptime: process.uptime(),
+  });
+});
+
+app.use((_req: Request, res: Response) => {
+  res.status(404).json({ success: false, message: 'Route not found' });
+});
+
+app.use((error: Error & { status?: number }, _req: Request, res: Response, _next: NextFunction) => {
+  console.error('🔥 Error:', error);
+  res.status(error.status ?? 500).json({
+    success: false,
+    message: error.message ?? 'Internal server error',
+  });
+});
+
+export default app;
+`;
+
+  // ─── src/server.ts ────────────────────────────────────────────────────────
+  files['src/server.ts'] = `import 'dotenv/config';
+import http from 'http';
+import app from './app';
+
+const PORT = process.env.PORT ?? ${port};
+const CLIENT_URL = process.env.CLIENT_URL ?? 'http://localhost:3000';
+const SERVER_URL = process.env.SERVER_URL ?? \`http://localhost:\${PORT}\`;
+
+const server = http.createServer(app);
+
+server.listen(PORT, () => {
+  console.log('\\n========================================');
+  console.log('  ${projectName} backend online');
+  console.log('  Server  :', SERVER_URL);
+  console.log('  Client  :', CLIENT_URL);
+  console.log('  Health  :', \`\${SERVER_URL}/health\`);
+  console.log('  Started :', new Date().toLocaleString());
+  console.log('========================================\\n');
+});
+
+const shutdown = () => {
+  console.log('\\n⚠️  Shutting down...');
+  server.close(() => { console.log('✅ Server closed.'); process.exit(0); });
+  setTimeout(() => { console.log('⏳ Forced exit.'); process.exit(1); }, 5000);
+};
+
+process.on('SIGINT', shutdown);
+process.on('SIGTERM', shutdown);
+
+export default server;
+`;
+
+  // ─── src/modules/index.ts ─────────────────────────────────────────────────
+  files['src/modules/index.ts'] = `import { Router } from 'express';
+import demoRoutes from './demo/demo.routes';
+${includeAuth ? `import authRoutes from './auth/auth.routes';\n` : ''}
+const router = Router();
+
+router.use('/demo', demoRoutes);
+${includeAuth ? `router.use('/auth', authRoutes);\n` : ''}
+export default router;
+`;
+
+  // ─── demo module ──────────────────────────────────────────────────────────
+  files['src/modules/demo/demo.validation.ts'] = `// src/modules/demo/demo.validation.ts
+import Joi from 'joi';
+
+export const createDemoValidation = Joi.object({
+  name: Joi.string().min(3).max(100).required(),
+  email: Joi.string().email().required(),
+  description: Joi.string().max(500).optional(),
+});
+
+export const updateDemoValidation = Joi.object({
+  name: Joi.string().min(3).max(100).optional(),
+  email: Joi.string().email().optional(),
+  description: Joi.string().max(500).optional(),
+});
+`;
+
+  files['src/modules/demo/demo.service.ts'] = `// src/modules/demo/demo.service.ts
+import prisma from '../../database/prisma';
+${includeFileUpload ? `import fs from 'fs';\n` : ''}
+class DemoService {
+  async createDemo(data: { name: string; email: string }) {
+    return prisma.user.create({ data: { email: data.email, name: data.name } });
+  }
+
+  async getAllDemos() {
+    return prisma.user.findMany({
+      ${includeFileUpload ? `include: { files: true },` : ''}
+      orderBy: { createdAt: 'desc' },
+    });
+  }
+
+  async getDemoById(id: string) {
+    const demo = await prisma.user.findUnique({
+      where: { id },
+      ${includeFileUpload ? `include: { files: true },` : ''}
+    });
+    if (!demo) throw new Error('Demo not found');
+    return demo;
+  }
+
+  async updateDemo(id: string, data: { name?: string; email?: string }) {
+    return prisma.user.update({ where: { id }, data });
+  }
+
+  async deleteDemo(id: string) {
+    await prisma.user.delete({ where: { id } });
+    return { message: 'Demo deleted successfully' };
+  }
+${includeFileUpload ? `
+  async uploadFile(userId: string, file: Express.Multer.File) {
+    try {
+      return await prisma.file.create({
+        data: {
+          filename: file.filename,
+          originalName: file.originalname,
+          path: file.path,
+          size: file.size,
+          mimetype: file.mimetype,
+          userId,
+        },
+      });
+    } catch (error: any) {
+      if (file.path && fs.existsSync(file.path)) fs.unlinkSync(file.path);
+      throw new Error(\`Failed to upload file: \${error.message}\`);
+    }
+  }
+
+  async getUserFiles(userId: string) {
+    return prisma.file.findMany({ where: { userId }, orderBy: { createdAt: 'desc' } });
+  }
+
+  async deleteFile(fileId: string, userId: string) {
+    const file = await prisma.file.findFirst({ where: { id: fileId, userId } });
+    if (!file) throw new Error('File not found');
+    if (fs.existsSync(file.path)) fs.unlinkSync(file.path);
+    await prisma.file.delete({ where: { id: fileId } });
+    return { message: 'File deleted successfully' };
+  }
+` : ''}
+}
+
+export default new DemoService();
+`;
+
+  files['src/modules/demo/demo.controller.ts'] = `// src/modules/demo/demo.controller.ts
+import { Request, Response, NextFunction } from 'express';
+import demoService from './demo.service';
+
+class DemoController {
+  async createDemo(req: Request, res: Response, next: NextFunction) {
+    try {
+      const result = await demoService.createDemo(req.body);
+      res.status(201).json({ success: true, message: 'Demo created successfully', data: result });
+    } catch (error) { next(error); }
+  }
+
+  async getAllDemos(_req: Request, res: Response, next: NextFunction) {
+    try {
+      const result = await demoService.getAllDemos();
+      res.status(200).json({ success: true, data: result });
+    } catch (error) { next(error); }
+  }
+
+  async getDemoById(req: Request, res: Response, next: NextFunction) {
+    try {
+      const result = await demoService.getDemoById(req.params.id);
+      res.status(200).json({ success: true, data: result });
+    } catch (error) { next(error); }
+  }
+
+  async updateDemo(req: Request, res: Response, next: NextFunction) {
+    try {
+      const result = await demoService.updateDemo(req.params.id, req.body);
+      res.status(200).json({ success: true, message: 'Demo updated successfully', data: result });
+    } catch (error) { next(error); }
+  }
+
+  async deleteDemo(req: Request, res: Response, next: NextFunction) {
+    try {
+      const result = await demoService.deleteDemo(req.params.id);
+      res.status(200).json({ success: true, message: result.message });
+    } catch (error) { next(error); }
+  }
+${includeFileUpload ? `
+  async uploadFile(req: Request, res: Response, next: NextFunction) {
+    try {
+      if (!req.file) { res.status(400).json({ success: false, message: 'No file uploaded' }); return; }
+      const userId = (req.user as any)?.id ?? 'demo-user-id';
+      const result = await demoService.uploadFile(userId, req.file);
+      res.status(201).json({ success: true, message: 'File uploaded successfully', data: result });
+    } catch (error) { next(error); }
+  }
+
+  async getUserFiles(req: Request, res: Response, next: NextFunction) {
+    try {
+      const userId = (req.user as any)?.id ?? 'demo-user-id';
+      const result = await demoService.getUserFiles(userId);
+      res.status(200).json({ success: true, data: result });
+    } catch (error) { next(error); }
+  }
+
+  async deleteFile(req: Request, res: Response, next: NextFunction) {
+    try {
+      const userId = (req.user as any)?.id ?? 'demo-user-id';
+      const result = await demoService.deleteFile(req.params.fileId, userId);
+      res.status(200).json({ success: true, message: result.message });
+    } catch (error) { next(error); }
+  }
+` : ''}
+}
+
+export default new DemoController();
+`;
+
+  files['src/modules/demo/demo.routes.ts'] = `// src/modules/demo/demo.routes.ts
+import { Router } from 'express';
+import demoController from './demo.controller';
+import { createDemoValidation, updateDemoValidation } from './demo.validation';
+import validate from '../../middleware/validate';
+${includeFileUpload ? `import upload from '../../middleware/upload';\n` : ''}
+const router = Router();
+
+router.post('/', validate(createDemoValidation), demoController.createDemo.bind(demoController));
+router.get('/', demoController.getAllDemos.bind(demoController));
+router.get('/:id', demoController.getDemoById.bind(demoController));
+router.put('/:id', validate(updateDemoValidation), demoController.updateDemo.bind(demoController));
+router.delete('/:id', demoController.deleteDemo.bind(demoController));
+${includeFileUpload ? `
+router.post('/upload', upload.single('file'), demoController.uploadFile.bind(demoController));
+router.get('/files/all', demoController.getUserFiles.bind(demoController));
+router.delete('/files/:fileId', demoController.deleteFile.bind(demoController));
+` : ''}
+export default router;
+`;
+
+  // ─── auth module (optional) ───────────────────────────────────────────────
+  if (includeAuth) {
+    files['src/modules/auth/auth.validation.ts'] = `// src/modules/auth/auth.validation.ts
+import Joi from 'joi';
+
+export const registerValidation = Joi.object({
+  name: Joi.string().min(2).max(100).required(),
+  email: Joi.string().email().required(),
+  password: Joi.string().min(6).required(),
+});
+
+export const loginValidation = Joi.object({
+  email: Joi.string().email().required(),
+  password: Joi.string().required(),
+});
+`;
+
+    files['src/modules/auth/auth.service.ts'] = `// src/modules/auth/auth.service.ts
+import bcrypt from 'bcryptjs';
+import jwt from 'jsonwebtoken';
+import prisma from '../../database/prisma';
+
+class AuthService {
+  async register(data: { name: string; email: string; password: string }) {
+    const existing = await prisma.user.findUnique({ where: { email: data.email } });
+    if (existing) {
+      const err: any = new Error('Email already registered');
+      err.status = 409;
+      throw err;
+    }
+    const hashed = await bcrypt.hash(data.password, 10);
+    const user = await prisma.user.create({
+      data: { name: data.name, email: data.email, password: hashed },
+    });
+    const { password: _, ...safe } = user;
+    return safe;
+  }
+
+  async login(data: { email: string; password: string }) {
+    const user = await prisma.user.findUnique({ where: { email: data.email } });
+    if (!user) { const e: any = new Error('Invalid credentials'); e.status = 401; throw e; }
+
+    const valid = await bcrypt.compare(data.password, user.password!);
+    if (!valid) { const e: any = new Error('Invalid credentials'); e.status = 401; throw e; }
+
+    const token = jwt.sign(
+      { id: user.id, email: user.email },
+      process.env.JWT_SECRET as string,
+      { expiresIn: process.env.JWT_EXPIRES_IN ?? '7d' }
+    );
+    const { password: _, ...safe } = user;
+    return { user: safe, token };
+  }
+}
+
+export default new AuthService();
+`;
+
+    files['src/modules/auth/auth.controller.ts'] = `// src/modules/auth/auth.controller.ts
+import { Request, Response, NextFunction } from 'express';
+import authService from './auth.service';
+
+class AuthController {
+  async register(req: Request, res: Response, next: NextFunction) {
+    try {
+      const result = await authService.register(req.body);
+      res.status(201).json({ success: true, message: 'Registered successfully', data: result });
+    } catch (error) { next(error); }
+  }
+
+  async login(req: Request, res: Response, next: NextFunction) {
+    try {
+      const result = await authService.login(req.body);
+      res.status(200).json({ success: true, message: 'Login successful', data: result });
+    } catch (error) { next(error); }
+  }
+}
+
+export default new AuthController();
+`;
+
+    files['src/modules/auth/auth.routes.ts'] = `// src/modules/auth/auth.routes.ts
+import { Router } from 'express';
+import authController from './auth.controller';
+import { registerValidation, loginValidation } from './auth.validation';
+import validate from '../../middleware/validate';
+
+const router = Router();
+
+router.post('/register', validate(registerValidation), authController.register.bind(authController));
+router.post('/login', validate(loginValidation), authController.login.bind(authController));
+
+export default router;
+`;
+  }
+
+  // ─── prisma.config.ts ─────────────────────────────────────────────────────
+  files['prisma.config.ts'] = `import { defineConfig } from '@prisma/config';
+import 'dotenv/config';
+
+export default defineConfig({
+  datasource: {
+    url: process.env.DATABASE_URL,
+  },
+});
+`;
+
+  // ─── README ───────────────────────────────────────────────────────────────
+  files['README.md'] = buildReadme({ projectName, port, includeFileUpload, includeAuth, language: 'ts' });
+
+  return files;
+}
+
+module.exports = { buildTsTemplates };