express-ts-api-starter 1.0.1

package/dist/server.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const app_1 = __importDefault(require("./app"));
+const envConfig_1 = require("./config/envConfig");
+const messages_1 = require("./messages");
+// Handle uncaught exceptions
+process.on(messages_1.EUncaughtExceptionMessages.uncaughtException, (err) => {
+    console.error(messages_1.EUncaughtExceptionMessages.uncaughtExceptionMessage, err.message);
+    console.error(err.stack);
+    process.exit(1);
+});
+const PORT = envConfig_1.env.PORT;
+const server = app_1.default.listen(PORT, () => {
+    console.info(`${messages_1.EServerStartMessages.serverStarted}`);
+    console.log(`${messages_1.EServerStartMessages.serverRunning}${PORT} ✅`);
+});
+// Handle unhandled promise rejections (async errors)
+process.on(messages_1.EUnhandledRejectionMessages.unhandledRejection, (reason) => {
+    console.error(messages_1.EUnhandledRejectionMessages.unhandledRejectionMessage, reason);
+    gracefulShutdown();
+});
+// ===== Graceful Shutdown Handler =====
+const gracefulShutdown = () => {
+    console.log(`\n${messages_1.EGracefulShutdownMessages.shutdownInitiated}`);
+    // Set a timeout for shutdown (30 seconds)
+    const shutdownTimeout = setTimeout(() => {
+        console.warn(messages_1.EGracefulShutdownMessages.shutdownTimeout);
+        process.exit(1);
+    }, 30000);
+    // Stop accepting new connections
+    server.close(() => {
+        console.log(messages_1.EGracefulShutdownMessages.serverClosed);
+        clearTimeout(shutdownTimeout);
+        console.log(messages_1.EGracefulShutdownMessages.connectionsClosed);
+        process.exit(0);
+    });
+    // Force exit after timeout
+    shutdownTimeout.unref();
+};
+// Handle termination signals for graceful shutdown
+process.on("SIGTERM", gracefulShutdown);
+process.on("SIGINT", gracefulShutdown);

package/dist/types/index.d.ts

@@ -0,0 +1,12 @@
+import { Types } from "mongoose";
+export type TGetAllQueryParams = {
+    search?: string;
+    sortBy?: string;
+    sortOrder?: string;
+    limit?: string;
+    offset?: string;
+};
+export type TGetOnePathParams = {
+    id: string | Types.ObjectId;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC;CAC7B,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/roleType.d.ts

@@ -0,0 +1,2 @@
+export type TRoles = "admin" | "manager" | "staff";
+//# sourceMappingURL=roleType.d.ts.map

package/dist/types/roleType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roleType.d.ts","sourceRoot":"","sources":["../../src/types/roleType.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC"}

package/dist/types/roleType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/userTypes.d.ts

@@ -0,0 +1,20 @@
+export type TRoles = "admin" | "user";
+export type TCreateUserBody = {
+    name: string;
+    email: string;
+    password: string;
+    role: TRoles;
+    phone: string;
+};
+export type TUser = {
+    name: string;
+    email: string;
+    password: string;
+    role: TRoles;
+    phone: string;
+};
+export type TUserLoginBody = {
+    email: string;
+    password: string;
+};
+//# sourceMappingURL=userTypes.d.ts.map

package/dist/types/userTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userTypes.d.ts","sourceRoot":"","sources":["../../src/types/userTypes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAEtC,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/types/userTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/authFunction.d.ts

@@ -0,0 +1,3 @@
+import { IUser } from "../interfaces/userInterface";
+export declare const generateJWT: (user: IUser) => Promise<string>;
+//# sourceMappingURL=authFunction.d.ts.map

package/dist/utils/authFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authFunction.d.ts","sourceRoot":"","sources":["../../src/utils/authFunction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAEpD,eAAO,MAAM,WAAW,GAAU,MAAM,KAAK,oBAU5C,CAAC"}

package/dist/utils/authFunction.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateJWT = void 0;
+const jwt = __importStar(require("jsonwebtoken"));
+const envConfig_1 = require("../config/envConfig");
+const generateJWT = async (user) => {
+    // JWT payload containing user information
+    const payload = {
+        userId: user._id,
+        role: user.role,
+        email: user.email,
+    };
+    // Generate and return the JWT
+    const token = await jwt.sign(payload, envConfig_1.env.JWT_SECRET, { expiresIn: "7d" });
+    return token;
+};
+exports.generateJWT = generateJWT;

package/dist/utils/responseUtil.d.ts

@@ -0,0 +1,5 @@
+import { Request, Response } from "express";
+export declare const sendErrorResponse: (statusCode: number, req: Request, res: Response, error: any, errorMessage: string) => void;
+export declare const sendSuccessResponse: <T>(statusCode: number, req: Request, res: Response, data: T, successMessage: string) => void;
+export declare const sendValidationErrorResponse: <T>(statusCode: number, res: Response, validationData: T, errorMessage: string) => void;
+//# sourceMappingURL=responseUtil.d.ts.map

package/dist/utils/responseUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseUtil.d.ts","sourceRoot":"","sources":["../../src/utils/responseUtil.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE5C,eAAO,MAAM,iBAAiB,GAC5B,YAAY,MAAM,EAClB,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,OAAO,GAAG,EACV,cAAc,MAAM,KACnB,IAIF,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,CAAC,EACnC,YAAY,MAAM,EAClB,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,MAAM,CAAC,EACP,gBAAgB,MAAM,KACrB,IAQF,CAAC;AAEF,eAAO,MAAM,2BAA2B,GAAI,CAAC,EAC3C,YAAY,MAAM,EAClB,KAAK,QAAQ,EACb,gBAAgB,CAAC,EACjB,cAAc,MAAM,KACnB,IAMF,CAAC"}

package/dist/utils/responseUtil.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendValidationErrorResponse = exports.sendSuccessResponse = exports.sendErrorResponse = void 0;
+const sendErrorResponse = (statusCode, req, res, error, errorMessage) => {
+    const requestId = req.headers["x-request-id"];
+    const message = errorMessage || error?.message;
+    res.status(statusCode).json({ success: false, requestId, error: message });
+};
+exports.sendErrorResponse = sendErrorResponse;
+const sendSuccessResponse = (statusCode, req, res, data, successMessage) => {
+    const requestId = req.headers["x-request-id"];
+    res.status(statusCode).json({
+        success: true,
+        requestId,
+        message: successMessage,
+        response: data,
+    });
+};
+exports.sendSuccessResponse = sendSuccessResponse;
+const sendValidationErrorResponse = (statusCode, res, validationData, errorMessage) => {
+    res.status(statusCode).json({
+        success: false,
+        message: errorMessage,
+        response: validationData,
+    });
+};
+exports.sendValidationErrorResponse = sendValidationErrorResponse;

package/dist/validators/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./userValidators";
+//# sourceMappingURL=index.d.ts.map

package/dist/validators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validators/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/validators/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./userValidators"), exports);

package/dist/validators/userValidators.d.ts

@@ -0,0 +1,3 @@
+export declare const registerValidator: (((req: import("express").Request, res: import("express").Response, next: import("express").NextFunction) => any) | import("express-validator").ValidationChain)[];
+export declare const loginValidator: (((req: import("express").Request, res: import("express").Response, next: import("express").NextFunction) => any) | import("express-validator").ValidationChain)[];
+//# sourceMappingURL=userValidators.d.ts.map

package/dist/validators/userValidators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userValidators.d.ts","sourceRoot":"","sources":["../../src/validators/userValidators.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,iBAAiB,oKAyB7B,CAAC;AAEF,eAAO,MAAM,cAAc,oKAO1B,CAAC"}

package/dist/validators/userValidators.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loginValidator = exports.registerValidator = void 0;
+const express_validator_1 = require("express-validator");
+const validatorMiddleware_1 = require("../middleware/validatorMiddleware");
+exports.registerValidator = [
+    (0, express_validator_1.body)("name")
+        .notEmpty()
+        .withMessage("Name is required")
+        .isLength({ min: 2 })
+        .withMessage("Name must be at least 2 characters"),
+    (0, express_validator_1.body)("email").isEmail().withMessage("A valid email is required"),
+    (0, express_validator_1.body)("password")
+        .isLength({ min: 6 })
+        .withMessage("Password must be at least 6 characters"),
+    (0, express_validator_1.body)("role")
+        .notEmpty()
+        .withMessage("Role is required")
+        .isIn(["admin", "user"])
+        .withMessage("Invalid role"),
+    (0, express_validator_1.body)("phone")
+        .notEmpty()
+        .withMessage("Phone number is required")
+        .isMobilePhone("en-IN")
+        .withMessage("Invalid phone number"),
+    validatorMiddleware_1.validatorFn,
+];
+exports.loginValidator = [
+    (0, express_validator_1.body)("email").isEmail().withMessage("A valid email is required"),
+    (0, express_validator_1.body)("password")
+        .isLength({ min: 6 })
+        .withMessage("Password must be at least 6 characters long"),
+    validatorMiddleware_1.validatorFn,
+];

package/package.json

@@ -0,0 +1,160 @@
+{
+  "name": "express-ts-api-starter",
+  "version": "1.0.1",
+  "description": "Production-ready Express.js + TypeScript boilerplate with MVC architecture, JWT auth, MongoDB, security, validation, and testing—build scalable REST APIs fast",
+  "main": "dist/server.js",
+  "types": "dist/server.d.ts",
+  "files": [
+    "dist",
+    "!dist/**/*.test.js",
+    "!dist/**/*.spec.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "dev": "node scripts/eslint-report.js && nodemon --exec ts-node src/server.ts",
+    "build": "tsc",
+    "start": "node dist/server.js",
+    "test": "jest",
+    "lint": "eslint --ext .ts,.js .",
+    "lint:fix": "eslint --ext .ts,.js . --fix",
+    "lint:report": "eslint --ext .ts,.js . --format json -o eslint-report.json && node scripts/eslint-report.js",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "express",
+    "express.js",
+    "typescript",
+    "nodejs",
+    "node.js",
+    "boilerplate",
+    "starter",
+    "starter-template",
+    "template",
+    "scaffold",
+    "mvc",
+    "mvc-architecture",
+    "rest-api",
+    "rest",
+    "api",
+    "backend",
+    "backend-template",
+    "server",
+    "web-server",
+    "authentication",
+    "jwt",
+    "json-web-token",
+    "auth",
+    "mongodb",
+    "mongoose",
+    "database",
+    "nosql",
+    "security",
+    "helmet",
+    "cors",
+    "validation",
+    "input-validation",
+    "middleware",
+    "production-ready",
+    "production",
+    "scalable",
+    "enterprise",
+    "testing",
+    "jest",
+    "test",
+    "error-handling",
+    "logging",
+    "logger",
+    "bcryptjs",
+    "password-hashing",
+    "express-validator",
+    "api-development",
+    "rest-api-development",
+    "web-development",
+    "full-stack",
+    "typescript-boilerplate",
+    "express-boilerplate",
+    "nodejs-boilerplate",
+    "rate-limiting",
+    "file-upload",
+    "multer",
+    "graceful-shutdown",
+    "request-tracking",
+    "request-id",
+    "modular-architecture",
+    "feature-based",
+    "monolithic",
+    "service-pattern",
+    "functional-programming",
+    "async-await",
+    "promises",
+    "error-middleware",
+    "logging-middleware",
+    "auth-middleware",
+    "validation-middleware",
+    "http-server",
+    "node-server",
+    "api-server",
+    "base-project",
+    "starter-project",
+    "dev-tools",
+    "development-tools"
+  ],
+  "author": {
+    "name": "Nikhil Plavalappil Kuttan",
+    "email": "nikhil.pk.connect@gmail.com",
+    "url": "https://github.com/nikhilpktcr"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nikhilpktcr/express-ts-starter.git",
+    "directory": "."
+  },
+  "bugs": {
+    "url": "https://github.com/nikhilpktcr/express-ts-starter/issues",
+    "email": "nikhil.pk.connect@gmail.com"
+  },
+  "homepage": "https://github.com/nikhilpktcr/express-ts-starter#readme",
+  "dependencies": {
+    "bcryptjs": "^3.0.2",
+    "chalk": "^5.4.1",
+    "cors": "^2.8.5",
+    "dotenv": "^16.5.0",
+    "express": "^5.1.0",
+    "express-rate-limit": "^7.5.1",
+    "express-throttle": "^2.0.0",
+    "express-validator": "^7.2.1",
+    "helmet": "^8.1.0",
+    "http-status-codes": "^2.3.0",
+    "jsonwebtoken": "^9.0.2",
+    "mongoose": "^8.16.3",
+    "morgan": "^1.10.0",
+    "multer": "^2.0.1",
+    "uuid": "^11.1.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.31.0",
+    "@tsconfig/node20": "^20.1.6",
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.3",
+    "@types/jest": "^30.0.0",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/morgan": "^1.9.10",
+    "@types/multer": "^2.0.0",
+    "@types/node": "^24.0.14",
+    "@typescript-eslint/eslint-plugin": "^8.37.0",
+    "@typescript-eslint/parser": "^8.37.0",
+    "eslint": "^9.31.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-import": "^2.32.0",
+    "globals": "^16.3.0",
+    "jest": "^30.0.4",
+    "nodemon": "^3.1.10",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.37.0"
+  }
+}