[IVM-97, SUB-99] Server: Add endpoint for search user via name or email

server/src/modules/user/controller.ts

@@ -43,3 +43,8 @@ export const restoreUser = async (req: Request, res: Response) => {
     message: 'User restored successful',
   });
 };
+
+export const searchUser = async (req: Request, res: Response) => {
+  const users = await userService.searchUsers(req.body);
+  return res.status(200).json(users);
+};

server/src/modules/user/service.ts

@@ -1,10 +1,12 @@
 import z from 'zod';
 import bcrypt from 'bcrypt';
+import type { QueryFilter } from 'mongoose';
 
-import { CreateUserSchema } from '@/schemas';
-import { UserModel } from './model';
+import { CreateUserSchema, SearchUserFilterSchema } from '@/schemas';
 import { envConfig } from '@/config';
-import { UpdateUser, User } from '@/types';
+import { PageResult, UpdateUser, User } from '@/types';
+
+import { UserDocument, UserModel } from './model';
 
 export const getHashedPassword = async (password: string) =>
   bcrypt.hash(password, envConfig.BCRYPT_SALT_ROUNDS);
@@ -92,7 +94,40 @@ export const verifyPassword = async (user: User, password: string) => {
   return bcrypt.compare(password, user.passwordHash);
 };
 
-
 export const getUserById = async (id: string) => {
   return UserModel.findById(id).exec(); // here exec() returns a Promise
-}
+};
+
+export const searchUsers = async (
+  filters: z.infer<typeof SearchUserFilterSchema>,
+): Promise<PageResult<User>> => {
+  let query: QueryFilter<UserDocument> = {
+    deleted: { $ne: true },
+  };
+
+  const searchQuery = filters.searchQuery?.trim();
+  if (searchQuery) {
+    query = {
+      ...query,
+      $or: [
+        { name: { $regex: searchQuery, $options: 'i' } },
+        { email: { $regex: searchQuery, $options: 'i' } },
+      ],
+    };
+  }
+
+  const skip = (filters.offset - 1) * filters.limit;
+  const limit = filters.limit;
+
+  const [users, total] = await Promise.all([
+    UserModel.find(query).skip(skip).limit(limit),
+    UserModel.countDocuments(query),
+  ]);
+
+  return {
+    data: users,
+    total,
+    offset: filters.offset,
+    limit: filters.limit,
+  };
+};

server/src/routes/admin/user.route.ts

@@ -2,7 +2,7 @@ import { Router } from 'express';
 
 import { userController } from '@/modules/user';
 import { validateRequestBody } from '@/middlewares';
-import { CreateUserSchema } from '@/schemas';
+import { CreateUserSchema, SearchUserFilterSchema } from '@/schemas';
 
 const adminUserRouter = Router();
 
@@ -17,5 +17,10 @@ adminUserRouter.get('/:id', userController.getUserById);
 adminUserRouter.put('/:id', userController.updateUserById);
 adminUserRouter.delete('/:id', userController.deleteUserById);
 adminUserRouter.patch('/:id/restore', userController.restoreUser);
+adminUserRouter.post(
+  '/search',
+  validateRequestBody(SearchUserFilterSchema),
+  userController.searchUser,
+);
 
 export default adminUserRouter;

server/src/schemas/mixin.ts

@@ -20,3 +20,12 @@ export const SoftDeleteMixin = z.object({
   deletedAt: z.union([z.date(), z.string()]).nullable().optional(),
   deletedBy: z.string().nullable().optional(),
 });
+
+export const ListRequestMixin = z.object({
+  offset: z.number().int().positive().optional().default(1),
+  limit: z.number().int().positive().optional().default(10),
+});
+
+export const SearchRequestMixin = z.object({
+  searchQuery: z.string().optional(),
+});

server/src/schemas/users.ts

@@ -1,6 +1,12 @@
 import { z } from 'zod';
 
-import { CreatedMixin, SoftDeleteMixin, UpdatedMixin } from './mixin';
+import {
+  CreatedMixin,
+  ListRequestMixin,
+  SearchRequestMixin,
+  SoftDeleteMixin,
+  UpdatedMixin,
+} from './mixin';
 
 export const UserRoleEnum = z.enum(['admin', 'shop-keeper']);
 
@@ -40,3 +46,9 @@ export const UpdateUserSchema = z
       .min(6, 'Password must be at least 6 characters long')
       .optional(),
   });
+
+export const SearchUserFilterSchema = z.object({
+  ...SearchRequestMixin.shape,
+  ...ListRequestMixin.shape,
+  // additional filters can be added here in the future
+});