@ifecodes/backend-template 1.1.9 → 1.4.0

package/package.json

@@ -1,55 +1,64 @@
-{
-  "name": "@ifecodes/backend-template",
-  "version": "1.1.9",
-  "description": "Production-ready Express + TypeScript/JavaScript backend generator with optional features and microservice support",
-  "bin": {
-    "ifecodes-template": "bin/cli.js"
-  },
-  "type": "module",
-  "files": [
-    "bin",
-    "template"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ALADETAN-IFE/backend-template.git"
-  },
-  "bugs": {
-    "url": "https://github.com/ALADETAN-IFE/backend-template/issues"
-  },
-  "homepage": "https://backend-template-generator.vercel.app",
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "cli",
-    "template",
-    "boilerplate",
-    "typescript",
-    "javascript",
-    "backend",
-    "express",
-    "microservice",
-    "monolith",
-    "nodejs",
-    "generator",
-    "scaffold",
-    "docker",
-    "pm2",
-    "jwt",
-    "authentication",
-    "colored-cli"
-  ],
-  "license": "MIT",
-  "author": "Aladetan Fortune Ifeloju (IfeCodes) <ifecodes01@gmail.com>",
-  "dependencies": {
-    "picocolors": "^1.1.1",
-    "prompts": "^2.4.2"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  }
-}
+{
+  "name": "@ifecodes/backend-template",
+  "version": "1.4.0",
+  "description": "Production-ready Express + TypeScript/JavaScript backend generator with optional features and microservice support",
+  "bin": {
+    "ifecodes-template": "bin/cli.js"
+  },
+  "type": "module",
+  "files": [
+    "bin",
+    "template"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "format": "prettier --write ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ALADETAN-IFE/backend-template.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ALADETAN-IFE/backend-template/issues"
+  },
+  "homepage": "https://backend-template-generator.vercel.app",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "cli",
+    "template",
+    "boilerplate",
+    "typescript",
+    "javascript",
+    "backend",
+    "express",
+    "microservice",
+    "monolith",
+    "nodejs",
+    "generator",
+    "scaffold",
+    "docker",
+    "pm2",
+    "jwt",
+    "authentication",
+    "colored-cli"
+  ],
+  "license": "MIT",
+  "author": "Aladetan Fortune Ifeloju (IfeCodes) <fortuneifealadetan01@gmail.com>",
+  "dependencies": {
+    "picocolors": "^1.1.1",
+    "prompts": "^2.4.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.60.0",
+    "@typescript-eslint/parser": "^8.60.0",
+    "eslint": "^10.4.1",
+    "eslint-config-prettier": "^10.1.8",
+    "prettier": "^2.8.8"
+  }
+}

package/template/base/js/.eslintrc.json

@@ -1,13 +1,10 @@
-{
-  "extends": [
-    "eslint:recommended",
-    "prettier"
-  ],
-  "env": {
-    "node": true,
-    "es2021": true
-  },
-  "rules": {
-    "no-unused-vars": ["warn"]
-  }
-}
+{
+  "extends": ["eslint:recommended", "prettier"],
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "rules": {
+    "no-unused-vars": ["warn"]
+  }
+}

package/template/base/js/.prettierrc

@@ -1,7 +1,7 @@
-{
-  "semi": true,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "printWidth": 80,
-  "tabWidth": 2
-}
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 80,
+  "tabWidth": 2
+}

package/template/base/js/eslint.config.js

@@ -1,31 +1,33 @@
-module.exports = [
-  {
-    ignores: ["node_modules/**", "dist/**"],
-  },
-  {
-    files: ["src/**/*.js"],
-    languageOptions: {
-      ecmaVersion: 2021,
-      sourceType: "module",
-      globals: {
-        console: "readonly",
-        process: "readonly",
-        Buffer: "readonly",
-        __dirname: "readonly",
-        __filename: "readonly",
-        require: "readonly",
-        module: "readonly",
-        exports: "writable",
-        global: "readonly",
-        setTimeout: "readonly",
-        setInterval: "readonly",
-        clearTimeout: "readonly",
-        clearInterval: "readonly",
-      },
-    },
-    rules: {
-      "no-unused-vars": "warn",
-      "no-undef": "error",
-    },
-  },
-];
+const tsParser = require('@typescript-eslint/parser');
+const tsPlugin = require('@typescript-eslint/eslint-plugin');
+
+module.exports = [
+  // Files/paths to ignore (replaces .eslintignore usage in flat config)
+  {
+    ignores: ['node_modules/**', 'dist/**'],
+  },
+
+  // TypeScript rules for source files
+  {
+    files: ['src/**/*.{ts,tsx}'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: './tsconfig.json',
+        tsconfigRootDir: __dirname,
+        ecmaVersion: 2020,
+        sourceType: 'module',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+    },
+    rules: {
+      // Disallow explicit `any`
+      '@typescript-eslint/no-explicit-any': 'error',
+
+      // You can add or tune more TypeScript rules here
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+    },
+  },
+];

package/template/base/js/package.json

@@ -1,28 +1,29 @@
-{
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "dev": "nodemon --exec node src/server.js",
-    "start": "node src/server.js",
-    "lint": "eslint \"src/**/*.js\"",
-    "format": "prettier --write \"src/**/*.{js,json}\"",
-    "check-format": "prettier --check \"src/**/*.{js,json}\"",
-    "prepare": "husky"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "commonjs",
-  "dependencies": {
-    "dotenv": "^16.3.1",
-    "express": "^5.2.1"
-  },
-  "devDependencies": {
-    "eslint": "^9.39.2",
-    "eslint-config-prettier": "^10.1.8",
-    "husky": "^9.1.7",
-     "nodemon": "^3.0.2",
-    "prettier": "^3.7.4"
-  }
-}
+{
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "dev": "nodemon --exec node src/server.js",
+    "start": "node src/server.js",
+    "lint": "eslint \"src/**/*.js\"",
+    "format": "prettier --write \"src/**/*.{js,json}\"",
+    "check-format": "prettier --check \"src/**/*.{js,json}\"",
+    "prepare": "husky"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "dotenv": "^16.3.1",
+    "express": "^5.2.1",
+    "swagger-ui-express": "^5.0.1"
+  },
+  "devDependencies": {
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "husky": "^9.1.7",
+    "nodemon": "^3.0.2",
+    "prettier": "^3.7.4"
+  }
+}

package/template/base/js/src/app.js

@@ -1,18 +1,20 @@
-const express = require("express");
-const router = require("./routes");
-const { errorHandler } = require("./middlewares");
-/*__IMPORTS__*/
-
-const app = express();
-
-// Parse JSON request bodies
-app.use(express.json());
-
-/*__MIDDLEWARE__*/
-
-// Connect routes
-app.use(router);
-
-app.use(errorHandler);
-
-module.exports = app;
+const express = require('express');
+const router = require('./routes');
+const { errorHandler, observabilityMiddleware } = require('./middlewares');
+/*__IMPORTS__*/
+
+const app = express();
+
+// Parse JSON request bodies
+app.use(express.json());
+
+app.use(observabilityMiddleware);
+
+/*__MIDDLEWARE__*/
+
+// Connect routes
+app.use(router);
+
+app.use(errorHandler);
+
+module.exports = app;

package/template/base/js/src/config/db.js

@@ -1,8 +1,8 @@
-// MongoDB connection will be added here when authentication is enabled
-const connectDB = async () => {
-  // Database connection placeholder
-};
-
-module.exports = {
-  connectDB,
-};
+// MongoDB connection will be added here when authentication is enabled
+const connectDB = async () => {
+  // Database connection placeholder
+};
+
+module.exports = {
+  connectDB,
+};

package/template/base/js/src/config/env.js

@@ -1,14 +1,44 @@
-const dotenv = require("dotenv");
-dotenv.config();
-
-const ENV = {
- PORT: process.env.PORT,
-  /*__ALLOWED_ORIGIN__*/
-  NODE_ENV: process.env.NODE_ENV,
-  /*__MONGO_URI__*/
-  /*__JWT_SECRET__*/
-};
-
-module.exports = {
-  ENV,
-};
+const dotenv = require('dotenv');
+dotenv.config();
+
+const colors = {
+  reset: '\x1b[0m',
+  red: '\x1b[31m',
+  bold: '\x1b[1m',
+};
+
+function format(tag, color) {
+  return `${color}${colors.bold}[${tag}]${colors.reset}`;
+}
+
+const validateEnv = (env) => {
+  const missing = Object.entries(env)
+    .filter(([, value]) => value === undefined || value === '')
+    .map(([key]) => key);
+
+  if (missing.length > 0) {
+    console.error(
+      format('env', colors.red),
+      `Missing required environment variables: ${missing.join(', ')}`
+    );
+    console.error(
+      format('env', colors.red),
+      'Please update your .env file and restart the server.'
+    );
+    process.exit(1);
+  }
+};
+
+const ENV = {
+  PORT: process.env.PORT,
+  /*__ALLOWED_ORIGIN__*/
+  NODE_ENV: process.env.NODE_ENV,
+  /*__MONGO_URI__*/
+  /*__JWT_SECRET__*/
+};
+
+validateEnv(ENV);
+
+module.exports = {
+  ENV,
+};

package/template/base/js/src/config/index.js

@@ -1,7 +1,7 @@
-const { connectDB } = require("./db");
-const { ENV } = require("./env");
-
-module.exports = {
-  connectDB,
-  ENV,
-};
+const { connectDB } = require('./db');
+const { ENV } = require('./env');
+
+module.exports = {
+  connectDB,
+  ENV,
+};

package/template/base/js/src/docs/index.js

@@ -0,0 +1,5 @@
+const { routeRegistry } = require('./route-registry');
+
+module.exports = {
+  routeRegistry,
+};

package/template/base/js/src/docs/route-registry.js

@@ -0,0 +1,63 @@
+class RouteRegistry {
+  constructor() {
+    this.routes = [];
+  }
+
+  register(route) {
+    this.routes.push(route);
+  }
+
+  getRoutes() {
+    return this.routes;
+  }
+
+  generateOpenAPI(projectName, version = '1.0.0') {
+    const paths = {};
+    const tags = new Set();
+
+    // Collect all unique tags
+    this.routes.forEach((route) => {
+      route.docs.tags?.forEach((tag) => tags.add(tag));
+    });
+
+    // Build paths from routes
+    this.routes.forEach((route) => {
+      if (!paths[route.path]) {
+        paths[route.path] = {};
+      }
+
+      const pathItem = paths[route.path];
+      const method = route.method.toLowerCase();
+
+      pathItem[method] = {
+        tags: route.docs.tags || [],
+        summary: route.docs.summary,
+        description: route.docs.description,
+        parameters: route.docs.parameters || [],
+        requestBody: route.docs.requestBody,
+        responses: route.docs.responses,
+      };
+    });
+
+    return {
+      openapi: '3.0.3',
+      info: {
+        title: `${projectName} API`,
+        version,
+        description: 'Auto-generated from route schemas.',
+      },
+      servers: [{ url: 'http://localhost:4000' }],
+      tags: Array.from(tags).map((tag) => ({
+        name: tag,
+        description: `${tag} endpoints`,
+      })),
+      paths,
+    };
+  }
+}
+
+const routeRegistry = new RouteRegistry();
+
+module.exports = {
+  routeRegistry,
+};

package/template/base/js/src/middlewares/error-handler.middleware.js

@@ -1,19 +1,22 @@
-const { HttpError } = require("../utils");
-
-const errorHandler = (err, _, res, __) => {
-  if (err instanceof HttpError) {
-    return res.status(err.status).json({
-      status: "error",
-      message: err.message,
-    });
-  }
-
-  return res.status(500).json({
-    status: "error",
-    message: "Internal Server Error",
-  });
-};
-
-module.exports = {
-  errorHandler,
-};
+const { HttpError, logger } = require('../utils');
+
+const errorHandler = (err, _, res, __) => {
+  if (err instanceof HttpError) {
+    logger.warn('ErrorHandler', `${err.status} ${err.message}`);
+    return res.status(err.status).json({
+      status: 'error',
+      message: err.message,
+    });
+  }
+
+  logger.error('ErrorHandler', 'Unhandled error', err);
+
+  return res.status(500).json({
+    status: 'error',
+    message: 'Internal Server Error',
+  });
+};
+
+module.exports = {
+  errorHandler,
+};

package/template/base/js/src/middlewares/index.js

@@ -1,11 +1,15 @@
-const methodNotAllowedHandler = require("./method-not-allowed.middleware");
-const { notFound } = require("./not-found.middleware");
-const { rootHandler } = require("./root.middleware");
-const { errorHandler } = require("./error-handler.middleware");
-
-module.exports = {
-  methodNotAllowedHandler,
-  notFound,
-  rootHandler,
-  errorHandler,
-};
+const methodNotAllowedHandler = require('./method-not-allowed.middleware');
+const { notFound } = require('./not-found.middleware');
+const { rootHandler } = require('./root.middleware');
+const { errorHandler } = require('./error-handler.middleware');
+const { observabilityMiddleware } = require('./observability.middleware');
+const { validateRequest } = require('./validation.middleware');
+
+module.exports = {
+  methodNotAllowedHandler,
+  notFound,
+  rootHandler,
+  errorHandler,
+  observabilityMiddleware,
+  validateRequest,
+};

package/template/base/js/src/middlewares/method-not-allowed.middleware.js

@@ -1,13 +1,19 @@
-const methodNotAllowed = (allowedMethods) => (req, res, next) => {
-  if (!allowedMethods.includes(req.method)) {
-    res.set("Allow", allowedMethods.join(", "));
-    return res.status(405).json({
-      status: "error",
-      message: `Method ${req.method} not allowed for ${req.originalUrl}`,
-      allowed: allowedMethods,
-    });
-  }
-  next();
-};
-
-module.exports = methodNotAllowed;
+import { logger } from '@/utils';
+
+const methodNotAllowed = (allowedMethods) => (req, res, next) => {
+  if (!allowedMethods.includes(req.method)) {
+    logger.warn(
+      'MethodNotAllowed',
+      `${req.method} ${req.originalUrl} | allowed: ${allowedMethods.join(', ')}`
+    );
+    res.set('Allow', allowedMethods.join(', '));
+    return res.status(405).json({
+      status: 'error',
+      message: `Method ${req.method} not allowed for ${req.originalUrl}`,
+      allowed: allowedMethods,
+    });
+  }
+  next();
+};
+
+module.exports = methodNotAllowed;

package/template/base/js/src/middlewares/not-found.middleware.js

@@ -1,10 +1,13 @@
-const notFound = (req, res) => {
-  res.status(404).json({
-    status: "error",
-    message: `Route ${req.originalUrl} not found`,
-  });
-};
-
-module.exports = {
-  notFound,
-};
+import { logger } from '@/utils';
+
+const notFound = (req, res) => {
+  logger.warn('NotFound', `${req.method} ${req.originalUrl}`);
+  res.status(404).json({
+    status: 'error',
+    message: `Route ${req.originalUrl} not found`,
+  });
+};
+
+module.exports = {
+  notFound,
+};

package/template/base/js/src/middlewares/observability.middleware.js

@@ -0,0 +1,24 @@
+const { randomUUID } = require('crypto');
+const { logger } = require('../utils');
+
+const observabilityMiddleware = (req, res, next) => {
+  const requestId = req.get('X-Request-Id') || randomUUID();
+  const startedAt = Date.now();
+
+  res.locals.requestId = requestId;
+  res.setHeader('X-Request-Id', requestId);
+
+  res.on('finish', () => {
+    const duration = Date.now() - startedAt;
+    logger.info(
+      'HTTP',
+      `${requestId} ${req.method} ${req.originalUrl} -> ${res.statusCode} (${duration}ms)`
+    );
+  });
+
+  next();
+};
+
+module.exports = {
+  observabilityMiddleware,
+};