express-ts-starter-ys-v1 1.0.0 → 1.0.2

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "express-ts-starter-ys-v1",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "dist/server.js",
   "types": "dist/server.d.ts",
-  "files": [
-    "dist"
-  ],
   "scripts": {
     "prepublishOnly": "npm run build",
     "build": "tsc",
@@ -23,9 +20,7 @@
     "dotenv": "^18.0.7",
     "express": "^5.3.0",
     "helmet": "^8.3.0",
-    "mongoose": "^9.11.1",
-    "pino": "^10.4.0",
-    "pino-pretty": "^13.2.0"
+    "mongoose": "^9.11.1"
   },
   "devDependencies": {
     "@types/cors": "^2.8.19",

package/src/app.ts

@@ -0,0 +1,38 @@
+import express, { Application, Request, Response } from 'express';
+import dotenv from 'dotenv';
+import cors from 'cors';
+import helmet from 'helmet';
+import { moduleRoutes } from './modules';
+
+
+dotenv.config();
+
+const app: Application = express();
+
+// Middlewares
+app.use(helmet({
+    contentSecurityPolicy: false,
+    crossOriginEmbedderPolicy: false,
+}));
+app.use(cors({
+    origin: '*',
+    methods: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'],
+}));
+app.use(express.json());
+
+// Base Route
+app.get('/', (req: Request, res: Response) => {
+    res.status(200).json({ message: 'API is running' });
+});
+
+// Module Routes
+moduleRoutes.forEach((route) => {
+    app.use(route.path, route.route);
+});
+
+// 404 Fallback Handler
+app.use((_req: Request, res: Response) => {
+    res.status(404).json({ message: 'Not found' });
+});
+
+export default app;

package/src/common/middleware/auth.middleware.ts

@@ -0,0 +1,14 @@
+import { Request, Response, NextFunction } from 'express';
+
+export const authMiddleware = (req: Request, res: Response, next: NextFunction) => {
+    // Placeholder authentication logic
+    const authHeader = req.headers.authorization;
+    
+    if (!authHeader) {
+        return res.status(401).json({ message: 'Unauthorized: No token provided' });
+    }
+
+    // You would typically verify your JWT or token here.
+    // For now, we'll just allow it to pass through.
+    next();
+};

package/src/config/database.ts

@@ -0,0 +1,16 @@
+
+import mongoose from 'mongoose';
+
+export const connectDatabase = async (): Promise<void> => {
+    try {
+        const mongoURI = process.env.MONGODB_URI || 'mongodb://localhost:27017/my-api';
+
+        await mongoose.connect(mongoURI);
+
+        console.log('MongoDB Connected Successfully');
+    } catch (error) {
+        console.error('Error connecting to MongoDB:', error);
+        // Exit process with failure
+        process.exit(1);
+    }
+};

package/src/modules/health/health.controller.ts

@@ -0,0 +1,7 @@
+import { Request, Response } from 'express';
+import { getHealthStatus } from './health.service';
+
+export const checkHealth = (req: Request, res: Response) => {
+  const healthData = getHealthStatus();
+  res.status(200).json(healthData);
+};

package/src/modules/health/health.routes.ts

@@ -0,0 +1,9 @@
+import { Router } from 'express';
+import { checkHealth } from './health.controller';
+import { authMiddleware } from '../../common/middleware/auth.middleware';
+
+const router = Router();
+
+router.get('/', authMiddleware, checkHealth);
+
+export default router;

package/src/modules/health/health.service.ts

@@ -0,0 +1,10 @@
+import { HealthStatus } from './health.types';
+
+export const getHealthStatus = (): HealthStatus => {
+    return {
+        status: 'OK',
+        message: 'API is healthy',
+        timestamp: new Date().toISOString(),
+        uptime: process.uptime()
+    };
+};

package/src/modules/health/health.types.ts

@@ -0,0 +1,6 @@
+export interface HealthStatus {
+    status: string;
+    message: string;
+    timestamp: string;
+    uptime: number;
+}

package/src/modules/index.ts

@@ -0,0 +1,14 @@
+import { Router } from 'express';
+import healthRoutes from "./health/health.routes";
+
+export interface ModuleRoute {
+    path: string;
+    route: Router;
+}
+
+export const moduleRoutes: ModuleRoute[] = [
+    {
+        path: '/health',
+        route: healthRoutes,
+    },
+];

package/src/server.ts

@@ -0,0 +1,7 @@
+import app from './app';
+
+const PORT = process.env.PORT || 3000;
+
+app.listen(PORT, () => {
+  console.log(`Server is running on port ${PORT}`);
+});

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "commonjs",
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "declarationMap": true
+  },
+  "include": ["src/**/*"]
+}