Migrate and test project to latest versions

.env

@@ -0,0 +1,16 @@
+NODE_ENV=development
+PORT=3000
+JWT_SECRET=test-secret-key-for-development
+
+# Database Configuration
+TYPEORM_CONNECTION=mongodb
+TYPEORM_HOST=localhost
+TYPEORM_PORT=27017
+TYPEORM_USERNAME=
+TYPEORM_PASSWORD=
+TYPEORM_DATABASE=nodejs_boilerplate
+
+# Agenda Configuration  
+AGENDA_DB_COLLECTION=jobs
+AGENDA_POOL_TIME=200
+AGENDA_CONCURRENCY=10

.eslintrc.js

@@ -0,0 +1,30 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ],
+  plugins: ['@typescript-eslint', 'prettier'],
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+    project: './tsconfig.json',
+  },
+  env: {
+    node: true,
+    es6: true,
+    jest: true,
+  },
+  rules: {
+    'prettier/prettier': 'error',
+    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    'no-console': ['warn', { allow: ['warn', 'error'] }],
+    'max-len': ['error', { code: 160 }],
+  },
+  ignorePatterns: ['dist/', 'node_modules/', '*.js'],
+};

jest.config.js

@@ -0,0 +1,25 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src', '<rootDir>/tests'],
+  testMatch: [
+    '**/__tests__/**/*.ts',
+    '**/?(*.)+(spec|test).ts'
+  ],
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/main.ts',
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: [
+    'text',
+    'lcov',
+    'html'
+  ],
+  moduleFileExtensions: ['ts', 'js', 'json'],
+  testTimeout: 30000,
+};

package.json

@@ -12,45 +12,50 @@
     "format": "prettier --write \"src/**/*.ts\"",
     "start:prod": "node dist/main.js",
     "start": "nodemon",
-    "lint": "tslint -p tsconfig.json -c tslint.json",
-    "test": "jest",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "test": "jest --passWithNoTests",
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=18.0.0"
   },
   "dependencies": {
     "agenda": "^5.0.0",
-    "argon2": "^0.31.1",
-    "body-parser": "^1.20.0",
+    "argon2": "^0.44.0",
+    "body-parser": "^2.2.0",
     "celebrate": "^15.0.1",
     "cors": "^2.8.5",
-    "dotenv": "^16.0.3",
-    "express": "^4.18.1",
+    "dotenv": "^17.2.1",
+    "express": "^5.1.0",
     "express-jwt": "^8.4.1",
-    "helmet": "^7.0.0",
-    "joi": "^17.6.0",
+    "helmet": "^8.1.0",
+    "joi": "^18.0.1",
     "jsonwebtoken": "^9.0.2",
-    "mongodb": "^6.2.0",
-    "reflect-metadata": "^0.1.13",
+    "mongodb": "^6.19.0",
+    "reflect-metadata": "^0.2.2",
     "typedi": "^0.10.0",
-    "typeorm": "^0.3.10",
+    "typeorm": "^0.3.26",
     "typeorm-typedi-extensions": "^0.4.1"
   },
   "devDependencies": {
-    "@types/cors": "^2.8.12",
-    "@types/express": "^4.17.13",
-    "@types/jest": "^29.5.6",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^20.8.9",
-    "chai": "^4.3.10",
-    "jest": "^29.7.0",
-    "nodemon": "^3.0.1",
-    "prettier": "^3.0.3",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.7.0",
-    "tslint": "^6.1.3",
-    "typescript": "^5.2.2"
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.3",
+    "@types/jest": "^30.0.0",
+    "@types/morgan": "^1.9.10",
+    "@types/node": "^24.3.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "chai": "^6.0.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^30.1.2",
+    "nodemon": "^3.1.10",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.2"
   }
 }

src/Exception/index.ts

@@ -1,10 +1,3 @@
-interface ExtendedErrorInterface {
-  name: string;
-  message: string;
-  code: string;
-  status: number;
-}
-
 /**
  * Exception to extend the error class to allow additional properties.
  *
@@ -16,7 +9,9 @@ interface ExtendedErrorInterface {
  * 3. code - Unique error code
  * 4. link - Know more link
  */
-class Exception extends Error {
+export class Exception extends Error {
+  public status!: number;
+  public code?: string;
   constructor(message: string, status: number = 500, code?: string, link?: string) {
     super(message);
 
@@ -74,7 +69,7 @@ class Exception extends Error {
     /**
      * Update the stack trace
      */
-    if (Error.hasOwnProperty('captureStackTrace')) {
+    if (Object.prototype.hasOwnProperty.call(Error, 'captureStackTrace')) {
       Error.captureStackTrace(this, this.constructor);
       return;
     }
@@ -87,6 +82,3 @@ class Exception extends Error {
     });
   }
 }
-
-interface Exception extends ExtendedErrorInterface {}
-export { Exception };

src/api/middlewares/attachCurrentUser.ts

@@ -7,7 +7,7 @@ import UserService from '../../services/users';
  * @param {*} res  Express res Object
  * @param {*} next  Express next Function
  */
-const attachCurrentUser = async (req, res, next) => {
+const attachCurrentUser = async (req: any, res: any, next: any) => {
   try {
     const userServiceInstance = Container.get(UserService);
     const userRecord = await userServiceInstance.findOne(req.auth.id);

src/api/middlewares/isAuth.ts

@@ -1,4 +1,4 @@
-import {expressjwt as jwt} from 'express-jwt';
+import { expressjwt as jwt } from 'express-jwt';
 import config from '../../config';
 
 /**
@@ -7,21 +7,21 @@ import config from '../../config';
  * Authorization: Bearer ${JWT}
  *
  */
-const getTokenFromHeader = (req) => {
+const getTokenFromHeader = (req: any) => {
   const { authorization } = req.headers;
   if (
     (authorization && authorization.split(' ')[0] === 'Token') ||
     (authorization && authorization.split(' ')[0] === 'Bearer')
   ) {
     return authorization.split(' ')[1];
   }
-  // tslint:disable-next-line: no-null-keyword
+  // eslint-disable-next-line @typescript-eslint/no-null-keyword
   return null;
 };
 
 const isAuth = jwt({
   algorithms: ['HS256'], // This is the default algorithm used by jsonwebtoken
-  secret: config.jwtSecret, // The _secret_ to sign the JWTs
+  secret: config.jwtSecret || 'default-secret-key', // The _secret_ to sign the JWTs
   getToken: getTokenFromHeader, // How to extract the JWT from the request
 });
 

src/api/routes/auth/index.ts

@@ -12,7 +12,7 @@ const route = Router();
 //   constructor(@Inject(AuthService) private authService: AuthService) {}
 // }
 
-export default (app) => {
+export default (app: any) => {
   app.use('/auth', route);
 
   route.post(

src/config/index.ts

@@ -1,9 +1,9 @@
-import * as dotenv from 'dotenv';
+import dotenv from 'dotenv';
 
 process.env.NODE_ENV = process.env.NODE_ENV || 'development';
 
 const envFound = dotenv.config();
-if (!envFound) {
+if (envFound.error) {
   // Throw generic error
   throw new Error("Couldn't find .env file");
 }
@@ -12,12 +12,12 @@ export default {
   /**
    *  Application port.
    */
-  port: parseInt(process.env.PORT) || 3000,
+  port: parseInt(process.env.PORT || '3000'),
 
   /**
    * JWT Secret
    */
-  jwtSecret: process.env.JWT_SECRET,
+  jwtSecret: process.env.JWT_SECRET || 'default-secret-key',
 
   /**
    * MongoDB connection options.
@@ -35,8 +35,8 @@ export default {
     /**
      * Database host port.
      */
-    // tslint:disable-next-line: radix
-    port: Number.parseInt(process.env.TYPEORM_PORT),
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    port: Number.parseInt(process.env.TYPEORM_PORT!),
     /**
      * Database username.
      */

src/loaders/index.ts

@@ -1,12 +1,12 @@
-import * as express from 'express';
+import express from 'express';
 import 'reflect-metadata';
 import database from './database';
 import server from './server';
 
 export default async (app: express.Application) => {
-  const connection = await database();
-  console.log('DB loaded and connected!');
+  await database();
+  console.warn('DB loaded and connected!');
 
   await server(app);
-  console.log('Server loaded!');
+  console.warn('Server loaded!');
 };

src/loaders/server.ts

@@ -1,7 +1,7 @@
 import bodyParser from 'body-parser';
-import { errors, celebrate, isCelebrateError } from 'celebrate';
+import { errors, isCelebrateError } from 'celebrate';
 import cors from 'cors';
-import * as express from 'express';
+import express from 'express';
 import helmet from 'helmet';
 import routes from '../api/routes';
 
@@ -16,13 +16,13 @@ export default (app: express.Application) => {
 
   /// catch 404 and forward to error handler
   app.use((req, res, next) => {
-    const error: Error = new Error('Not Found');
-    error['status'] = 404;
+    const error: any = new Error('Not Found');
+    error.status = 404;
     next(error);
   });
 
   /// error handlers
-  app.use((err, req, res, next) => {
+  app.use((err: any, req: any, res: any, next: any) => {
     /**
      * Handle 401 thrown by express-jwt library
      */
@@ -39,7 +39,7 @@ export default (app: express.Application) => {
     return next(err);
   });
 
-  app.use((err, req, res, next) => {
+  app.use((err: any, req: any, res: any, _next: any) => {
     res.status(err.status || 500);
     res.json({
       errors: {

src/main.ts

@@ -1,9 +1,9 @@
-import * as express from 'express';
+import express from 'express';
 import config from './config';
 import loaders from './loaders';
 
 async function main() {
-  const app = express.default();
+  const app = express();
   await loaders(app);
 
   app.listen(config.port, () => {

src/models/User.ts

@@ -17,41 +17,41 @@ export enum Role {
 @Entity()
 export class User {
   @ObjectIdColumn()
-  public id: ObjectId;
+  public id!: ObjectId;
 
   @Column()
-  public name: string;
+  public name!: string;
 
   @Index({ unique: true })
   @Column({
     unique: true,
     nullable: false,
     transformer: [lowercase],
   })
-  public email: string;
+  public email!: string;
 
   @Column({
     select: false,
     nullable: false,
   })
-  public password: string;
+  public password!: string;
 
   @Column({
     select: false,
     nullable: false,
   })
-  public salt: string;
+  public salt!: string;
 
   @Column({ type: 'enum', enum: Role, default: Role.User })
-  public role: Role;
+  public role!: Role;
 
   @Column()
   @CreateDateColumn()
-  public createdAt: Date;
+  public createdAt!: Date;
 
   @Column()
   @UpdateDateColumn()
-  public updatedAt: Date;
+  public updatedAt!: Date;
 
   // @AfterLoad()
   // public deletePropertis(): void {