add user pagination

src/controllers/UserController.ts

@@ -1,7 +1,11 @@
 import { NextFunction, Request, Response } from "express";
 import { UserService } from "../services/UserService";
-import { CreateUserRequest, UpdateUserRequest } from "../types";
-import { validationResult } from "express-validator";
+import {
+    CreateUserRequest,
+    UpdateUserRequest,
+    UserQueryParams,
+} from "../types";
+import { matchedData, validationResult } from "express-validator";
 import createHttpError from "http-errors";
 import { Logger } from "winston";
 
@@ -71,11 +75,20 @@ export class UserController {
     }
 
     async getAll(req: Request, res: Response, next: NextFunction) {
+        const validateQuery = matchedData(req, {
+            onlyValidData: true,
+        });
         try {
-            const users = await this.userService.getAll();
-
+            const [users, count] = await this.userService.getAll(
+                validateQuery as UserQueryParams,
+            );
             this.logger.info("All users have been fetched");
-            res.json(users);
+            res.json({
+                data: users,
+                currentPage: validateQuery.currentPage as number,
+                perPage: validateQuery.perPage as number,
+                total: count,
+            });
         } catch (err) {
             next(err);
         }

src/routes/user.ts

@@ -10,6 +10,8 @@ import { CreateUserRequest, UpdateUserRequest } from "../types";
 import logger from "../config/logger";
 import createUserValidator from "../validators/create-user-validator";
 import updateUserValidator from "../validators/update-user-validator";
+import listUsersValidator from "../validators/list-users-validator";
+import { Request } from "express-jwt";
 
 const router = express.Router();
 const userRepository = AppDataSource.getRepository(User);
@@ -38,7 +40,8 @@ router.get(
     "/",
     authenticate as RequestHandler,
     canAccess([Roles.ADMIN]),
-    (req, res, next) =>
+    listUsersValidator,
+    (req: Request, res: Response, next: NextFunction) =>
         userController.getAll(req, res, next) as unknown as RequestHandler,
 );
 

src/services/UserService.ts

@@ -1,6 +1,6 @@
 import { Repository } from "typeorm";
 import { User } from "../entity/User";
-import { LimitedUserData, UserData } from "../types";
+import { LimitedUserData, UserData, UserQueryParams } from "../types";
 import createHttpError from "http-errors";
 import bcrypt from "bcryptjs";
 
@@ -82,9 +82,16 @@ export class UserService {
             throw error;
         }
     }
-    async getAll() {
-        return await this.userRepository.find();
+    async getAll(validateQuery: UserQueryParams) {
+        const queryBuilder = this.userRepository.createQueryBuilder("user");
+        const result = await queryBuilder
+            .skip((validateQuery.currentPage - 1) * validateQuery.perPage)
+            .take(validateQuery.perPage)
+            .getManyAndCount();
+
+        return result;
     }
+
     async deleteById(userId: number) {
         return await this.userRepository.delete(userId);
     }

src/types/index.ts

@@ -52,3 +52,8 @@ export interface LimitedUserData {
 export interface UpdateUserRequest extends Request {
     body: LimitedUserData;
 }
+
+export interface UserQueryParams {
+    perPage: number;
+    currentPage: number;
+}

src/validators/list-users-validator.ts

@@ -0,0 +1,23 @@
+import { checkSchema } from "express-validator";
+
+export default checkSchema(
+    {
+        currentPage: {
+            customSanitizer: {
+                options: (value) => {
+                    const parsedValue = Number(value);
+                    return Number.isNaN(parsedValue) ? 1 : parsedValue;
+                },
+            },
+        },
+        perPage: {
+            customSanitizer: {
+                options: (value) => {
+                    const parsedValue = Number(value);
+                    return Number.isNaN(parsedValue) ? 6 : parsedValue;
+                },
+            },
+        },
+    },
+    ["query"],
+);