Fix eslint

Author: cham11ng

.dockerignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -5,7 +5,7 @@
   </a>
 </p>
 
-Starter for Node.js Express API in Typescript with jsonwebtoken, joi, Knex, Objection.js and many other popular tools.
+Starter for Node.js, Express API in Typescript and PostgreSQL with jsonwebtoken, joi, Knex, Objection.js and many other popular tools.
 
 ## Requirements
 
@@ -16,8 +16,6 @@ Starter for Node.js Express API in Typescript with jsonwebtoken, joi, Knex, Obje
 
 ## Getting Started
 
-Clone the repository, install the dependencies.
-
 ```bash
 # Clone repository
 $ git clone [email protected]:cham11ng/typescript-api-starter.git <application-name>
@@ -27,6 +25,9 @@ $ cd <application-name>
 # Update database credentials
 $ cp .env.example .env
 
+# Install dependencies
+$ yarn install
+
 $ yarn migrate
 ```
 
@@ -53,60 +54,54 @@ $ yarn dev
   <a href="https://imgur.com/gallery/4rhTo"><img src="https://i.imgur.com/GpcDbLB.gif" /></a>
 </p>
 
-**Using Docker**
-
-Make a copy of `.env.docker` and save as `.env`.
+### Using Docker
 
 ```bash
+# Make a copy of `.env.docker` and save as `.env`.
 $ cp .env.docker .env
 ```
 
 Install dependencies and run the application locally.
 
 ```bash
-$ docker compose up -d postgres
-
 $ docker compose up -d api
 
-$ docker compose exec api sh yarn migrate # Make sure server is started checking logs before running this command
+# Make sure server is started checking logs before running this command
+$ docker compose exec api sh yarn migrate
 ```
 
-View logs of the container.
-
 ```bash
-$ docker compose logs -f
-```
+# View logs of the container.
+$ docker compose logs -f api
 
-To stop the services.
-
-```bash
+# To stop the services.
 $ docker compose stop api postgres
 ```
 
 ## Generating Migrations and Seeds
 
-To create migration use `make:migration` and seed use `make:seeder`:
-
 ```bash
+# To create migration use `make:migration`
 $ yarn make:migration create_{table_name}_table
 
+# To create seed use `make:seeder`
 $ yarn make:seeder {table_name}_table_seeder
 ```
 
-Example,
-
 ```bash
+# Example
 $ yarn make:migration create_posts_table
-
 $ yarn make:seeder post_table_seeder
 ```
 
 Modify migration and seeder file as per the requirement. Then finally:
 
 ```bash
-$ yarn migrate # to migrate
+# to migrate
+$ yarn migrate
 
-$ yarn seed # to seed
+# to seed
+$ yarn seed
 ```
 
 ## Setting up REST Client
@@ -120,7 +115,7 @@ Create a file or add following lines in `.vscode` > `settings.json` and switch a
       "refreshToken": "foo",
       "accessToken": "bar",
       "email": "[email protected]",
-      "password": "secret" 
+      "password": "secret"
     },
     "local": {
       "host": "localhost",

src/controllers/home.ts

@@ -5,17 +5,9 @@ import config from '../config/config';
 
 const { name, version } = config;
 
-/**
- * Handle / GET request, responds API information.
- *
- * @param {Request} req
- * @param _
- * @param {Response} res
- * @returns {void}
- */
-export function index(_: Request, res: Response): void {
+export const index = (_: Request, res: Response): void => {
   res.status(StatusCodes.OK).json({
     name,
     version
   });
-}
+};

src/controllers/user.ts

@@ -7,15 +7,7 @@ import * as userService from '../services/userService';
 
 const { messages } = config;
 
-/**
- * Handle /users GET request.
- *
- * @param {Request} req
- * @param _
- * @param {Response} res
- * @param {NextFunction} next
- */
-export async function index(_: Request, res: Response, next: NextFunction): Promise<void> {
+export const index = async (_: Request, res: Response, next: NextFunction): Promise<void> => {
   try {
     const response = await userService.fetchAll();
 
@@ -27,16 +19,9 @@ export async function index(_: Request, res: Response, next: NextFunction): Prom
   } catch (err) {
     next(err);
   }
-}
+};
 
-/**
- * Handle /users POST request.
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
- */
-export async function store(req: Request, res: Response, next: NextFunction): Promise<void> {
+export const store = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
   try {
     const userPayload = req.body as UserPayload;
 
@@ -50,4 +35,4 @@ export async function store(req: Request, res: Response, next: NextFunction): Pr
   } catch (err) {
     next(err);
   }
-}
+};

src/database/migrations/20170517164638_create_user_roles_table.ts

@@ -5,7 +5,8 @@ import Table from '../../resources/enums/Table';
 /**
  * Add user_roles table.
  *
- * @param {Knex} knex
+ * @param {Knex} knex - knex instance.
+ * @returns {Promise<void>}
  */
 export function up(knex: Knex): Promise<void> {
   return knex.schema
@@ -38,7 +39,8 @@ export function up(knex: Knex): Promise<void> {
 /**
  * Drop user_roles table.
  *
- * @param {Knex} knex
+ * @param {Knex} knex - knex instance.
+ * @returns {Knex.SchemaBuilder}
  */
 export function down(knex: Knex): Knex.SchemaBuilder {
   return knex.schema.dropTable(Table.USER_ROLES);

src/database/migrations/20180130005620_create_users_table.ts

@@ -3,8 +3,10 @@ import { Knex } from 'knex';
 import Table from '../../resources/enums/Table';
 
 /**
+ * Add users table.
  *
- * @param knex
+ * @param {Knex} knex - knex instance.
+ * @returns {Knex.SchemaBuilder}
  */
 export function up(knex: Knex): Knex.SchemaBuilder {
   return knex.schema.createTable(Table.USERS, (table) => {
@@ -19,8 +21,10 @@ export function up(knex: Knex): Knex.SchemaBuilder {
 }
 
 /**
+ * Drop users table.
  *
- * @param knex
+ * @param {Knex} knex - knex instance.
+ * @returns {Knex.SchemaBuilder}
  */
 export function down(knex: Knex): Knex.SchemaBuilder {
   return knex.schema.dropTable(Table.USERS);

src/database/migrations/20180517164647_create_user_sessions_table.ts

@@ -3,8 +3,10 @@ import { Knex } from 'knex';
 import Table from '../../resources/enums/Table';
 
 /**
+ * Add user_sessions table.
  *
- * @param knex
+ * @param knex - knex instance.
+ * @returns {Knex.SchemaBuilder}
  */
 export function up(knex: Knex): Knex.SchemaBuilder {
   return knex.schema.createTable(Table.USER_SESSIONS, (table) => {
@@ -19,8 +21,10 @@ export function up(knex: Knex): Knex.SchemaBuilder {
 }
 
 /**
+ * Drop user_sessions table.
  *
- * @param knex
+ * @param knex - knex instance.
+ * @returns {Knex.SchemaBuilder}
  */
 export function down(knex: Knex): Knex.SchemaBuilder {
   return knex.schema.dropTable(Table.USER_SESSIONS);

src/database/seeds/user_table_seeder.ts

@@ -5,10 +5,12 @@ import Table from '../../resources/enums/Table';
 import * as bcrypt from '../../utils/bcrypt';
 
 /**
+ * Seed users table.
  *
- * @param knex
+ * @param {Knex} knex - knex instance.
+ * @returns {Promise<number[] | number[][]>}
  */
-export function seed(knex: Knex): Promise<any> {
+export function seed(knex: Knex): Promise<number[] | number[][]> {
   return knex(Table.USERS).then(async () => {
     return Promise.all([
       knex(Table.USERS).insert([

src/domain/misc/ResponseData.ts

@@ -0,0 +1,5 @@
+import JWTPayload from './JWTPayload';
+
+type ResponseData = Request & { data: JWTPayload };
+
+export default ResponseData;

src/middlewares/authenticate.ts

@@ -2,6 +2,7 @@ import { NextFunction, Request, Response } from 'express';
 import { JsonWebTokenError } from 'jsonwebtoken';
 
 import config from '../config/config';
+import ResponseData from '../domain/misc/ResponseData';
 import BadRequestError from '../exceptions/BadRequestError';
 import UnauthorizedError from '../exceptions/UnauthorizedError';
 import { tokenErrorMessageMap } from '../resources/constants/maps';
@@ -20,7 +21,7 @@ const authenticate = async (req: Request, res: Response, next: NextFunction): Pr
     }
 
     logger.log('info', 'JWT: Verifying token - %s', res.locals.accessToken);
-    const response: any = jwt.verifyAccessToken(res.locals.accessToken);
+    const response = jwt.verifyAccessToken(res.locals.accessToken) as ResponseData;
 
     res.locals.loggedInPayload = response.data;
 

src/middlewares/genericErrorHandler.ts

@@ -4,13 +4,15 @@ import { getReasonPhrase, StatusCodes } from 'http-status-codes';
 import APIResponseInterface from '../domain/responses/APIResponse';
 import logger from '../utils/logger';
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const buildError = (err: any): APIResponseInterface<{ code: number; message: string; data?: any }> => {
   if (err.isJoi) {
     return {
       code: StatusCodes.BAD_REQUEST,
       message: getReasonPhrase(StatusCodes.BAD_REQUEST),
       data:
         err.details &&
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         err.details.map((error: any) => ({
           param: error.path.join('.'),
           message: error.message
@@ -39,10 +41,10 @@ export const buildError = (err: any): APIResponseInterface<{ code: number; messa
 };
 
 const genericErrorHandler = (
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   err: any,
   _: Request,
   res: Response,
-  // TODO: Remove this.
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   __: NextFunction
 ): void => {

src/middlewares/rateLimitHandler.ts

@@ -1,11 +1,12 @@
 import { rateLimit } from 'express-rate-limit';
 
-// write express rateLimit best practices
 const rateLimitMiddleware = rateLimit({
   windowMs: 15 * 60 * 1000, // 15 minutes
   max: 100, // limit each IP to 100 requests per windowMs
   message: 'Too many requests from this IP, please try again after 15 minutes',
-  headers: true
+  headers: true,
+  legacyHeaders: false,
+  standardHeaders: true
 });
 
 export default rateLimitMiddleware;

src/middlewares/transactionHandler.ts

@@ -10,7 +10,7 @@ const transactionHandler = (req: Request, _: Response, next: NextFunction): void
     const transactionId = req.headers['transactionId'] || randomUUID();
 
     // Set the TransactionId inside the store
-    context.getStore().set('transactionId', transactionId);
+    context.getStore()?.set('transactionId', transactionId);
 
     next();
   });

src/middlewares/validateRefreshToken.ts

@@ -1,6 +1,7 @@
 import { NextFunction, Request, Response } from 'express';
 
 import config from '../config/config';
+import ResponseData from '../domain/misc/ResponseData';
 import BadRequestError from '../exceptions/BadRequestError';
 import UnauthorizedError from '../exceptions/UnauthorizedError';
 import { tokenErrorMessageMap } from '../resources/constants/maps';
@@ -19,13 +20,14 @@ const validateRefreshToken = async (req: Request, res: Response, next: NextFunct
     }
 
     logger.log('info', 'JWT: Verifying token - %s', res.locals.refreshToken);
-    const response: any = jwt.verifyRefreshToken(res.locals.refreshToken);
+    const response = jwt.verifyRefreshToken(res.locals.refreshToken) as ResponseData;
 
     res.locals.jwtPayload = response.data;
 
     logger.log('debug', 'JWT: Authentication verified -', res.locals.jwtPayload);
 
     next();
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } catch (err: any) {
     const tokenErrorMessage = tokenErrorMessageMap[err.name as JWTErrorType];
     logger.log('error', 'JWT: Authentication failed - %s', err.message);

src/resources/stubs/migration.stub

@@ -1,5 +1,11 @@
 import * as Knex from 'knex';
 
+/**
+ * Add :table table.
+ *
+ * @param {Knex} knex - knex instance.
+ * @returns {Promise<Knex.SchemaBuilder>}
+ */
 export function up(knex: Knex): Knex.SchemaBuilder {
   return knex.schema.createTable('table_name', (table) => {
     table.increments('id').primary();
@@ -8,6 +14,12 @@ export function up(knex: Knex): Knex.SchemaBuilder {
   });
 }
 
+/**
+ * Drop :table table.
+ *
+ * @param {Knex} knex - knex instance.
+ * @returns {Knex.SchemaBuilder}
+ */
 export function down(knex: Knex): Knex.SchemaBuilder {
   return knex.schema.dropTable('table_name');
 }

src/resources/stubs/seed.stub

@@ -1,6 +1,12 @@
 import * as Knex from 'knex';
 
-export function seed(knex: Knex): Knex.SchemaBuilder {
+/**
+ * Seed :table table
+
+ * @param {Knex} knex - knex instance.
+ * @returns {Promise<number[] | number[][]>}
+ */
+export function seed(knex: Knex): Promise<number[] | number[][]> {
   return knex('table_name')
     .del()
     .then(() => {