Дипломный проект представляет собой сайт-агрегатор просмотра и бронирования гостиниц. Ваша задача заключается в разработке бэкенда для сайта-агрегатора с реализацией возможности бронирования гостиниц на диапазон дат.

1. Разработка публичного API.
2. Разработка API пользователя.
3. Разработка API администратора.
4. Разработка чата консультанта.

• Node.js;
• Nest.js;
• MongoDB;
• WebSocket.

Оплату бронирования реализовывать не нужно.

В документе приводятся описания разных интерфейсов и типов. Для упрощения описания в этом разделе приводятся общие типы.

type ID = string | ObjectId;

Базовые модули используются для описания бизнес-логики и хранения данных.

Модуль «Пользователи» предназначается для создания, хранения и поиска профилей пользователей.

Модуль «Пользователи» используется функциональными модулями для регистрации и аутентификации.

Данные пользователя должны храниться в MongoDB.

Модель данных User пользователя должна содержать поля:

Модуль «Пользователи» должен быть реализован в виде NestJS-модуля и экспортировать сервисы с интерфейсами:

interface SearchUserParams {
  limit: number;
  offset: number;
  email: string;
  name: string;
  contactPhone: string;
}
interface IUserService {
  create(data: Partial<User>): Promise<User>;
  findById(id: ID): Promise<User>;
  findByEmail(email: string): Promise<User>;
  findAll(params: SearchUserParams): Promise<User[]>;
}

Поле role может принимать одно из значений:

• client,
• admin,
• manager.

При поиске IUserService.findAll() поля email, name и contactPhone должны проверяться на частичное совпадение.

Модуль «Гостиницы» предназначается для хранения и поиска гостиниц и комнат.

Модуль «Гостиницы» используется функциональными модулями для показа списка мест для бронирования, а также для их добавления, включения и выключения.

Данные должны храниться в MongoDB.

Модель данных Hotel должна содержать поля:

Модель данных HotelRoom должна содержать поля:

Свойство hotel должно ссылаться на модель Hotel.

Модуль «Гостиницы» должен быть реализован в виде NestJS-модуля и экспортировать сервисы с интерфейсами:

interface SearchHotelParams {
  limit: number;
  offset: number;
  title: string;
}

interface UpdateHotelParams {
  title: string;
  description: string;
}

interface IHotelService {
  create(data: any): Promise<Hotel>;
  findById(id: ID): Promise<Hotel>;
  search(params: SearchHotelParams): Promise<Hotel[]>;
  update(id: ID, data: UpdateHotelParams): Promise<Hotel>;
}

interface SearchRoomsParams {
  limit: number;
  offset: number;
  hotel: ID;
  isEnabled?: boolean;
}

interface HotelRoomService {
  create(data: Partial<HotelRoom>): Promise<HotelRoom>;
  findById(id: ID): Promise<HotelRoom>;
  search(params: SearchRoomsParams): Promise<HotelRoom[]>;
  update(id: ID, data: Partial<HotelRoom>): Promise<HotelRoom>;
}

В методе search флаг isEnabled может принимать только boolean значения или может быть не передан, тогда должны вернутся все записи:

• true — флаг должен использоваться в фильтрации;
• undefined — если не передан параметр, флаг должен игнорироваться.

Модуль «Брони» предназначен для хранения и получения броней гостиниц конкретного пользователя.

Модуль «Брони» не должен использовать модуль «Пользователи» и модуль «Гостиницы» для получения данных.

Модуль «Брони» не должен хранить данные пользователей и гостиниц.

Модуль «Брони» должен использовать соединение с базой данных.

Данные должны храниться в MongoDB.

Модель данных Reservation должна содержать поля:

Модуль «Брони» должен быть реализован в виде NestJS-модуля и экспортировать сервисы с интерфейсами:

interface ReservationDto {
  userId: ID;
  hotelId: ID;
  roomId: ID;
  dateStart: Date;
  dateEnd: Date;
}

interface ReservationSearchOptions {
  userId: ID;
  dateStart: Date;
  dateEnd: Date;
}
interface IReservation {
  addReservation(data: ReservationDto): Promise<Reservation>;
  removeReservation(id: ID): Promise<void>;
  getReservations(
    filter: ReservationSearchOptions
  ): Promise<Array<Reservation>>;
}

Метод IReservation.addReservation должен проверять, доступен ли номер на заданную дату.

Модуль «Чат техподдержки» предназначается для хранения обращений в техподдержку и сообщений в чате обращения.

Модуль «Чат техподдержки» используется функциональными модулями для реализации возможности общения пользователей с поддержкой.

Данные чатов должны храниться в MongoDB.

Модель данных чата SupportRequest должна содержать поля:

Модель сообщения Message должна содержать поля:

Сообщение считается прочитанным, когда поле readAt не пустое.

Модуль «Чат техподдержки» должен быть реализован в виде NestJS-модуля и должен экспортировать сервисы с интерфейсами:

interface CreateSupportRequestDto {
  user: ID;
  text: string;
}

interface SendMessageDto {
  author: ID;
  supportRequest: ID;
  text: string;
}
interface MarkMessagesAsReadDto {
  user: ID;
  supportRequest: ID;
  createdBefore: Date;
}

interface GetChatListParams {
  user: ID | null;
  isActive: bool;
}

interface ISupportRequestService {
  findSupportRequests(params: GetChatListParams): Promise<SupportRequest[]>;
  sendMessage(data: SendMessageDto): Promise<Message>;
  getMessages(supportRequest: ID): Promise<Message[]>;
  subscribe(
    handler: (supportRequest: SupportRequest, message: Message) => void
  ): () => void;
}

interface ISupportRequestClientService {
  createSupportRequest(data: CreateSupportRequestDto): Promise<SupportRequest>;
  markMessagesAsRead(params: MarkMessagesAsReadDto);
  getUnreadCount(supportRequest: ID): Promise<Message[]>;
}

interface ISupportRequestEmployeeService {
  markMessagesAsRead(params: MarkMessagesAsReadDto);
  getUnreadCount(supportRequest: ID): Promise<Message[]>;
  closeRequest(supportRequest: ID): Promise<void>;
}

1. Метод ISupportRequestClientService.getUnreadCount должен возвращать количество сообщений, которые были отправлены любым сотрудником поддержки и не отмечены прочитанным.
2. Метод ISupportRequestClientService.markMessagesAsRead должен выставлять текущую дату в поле readAt всем сообщениям, которые не были прочитаны и были отправлены не пользователем.
3. Метод ISupportRequestEmployeeService.getUnreadCount должен возвращать количество сообщений, которые были отправлены пользователем и не отмечены прочитанными.
4. Метод ISupportRequestEmployeeService.markMessagesAsRead должен выставлять текущую дату в поле readAt всем сообщениям, которые не были прочитаны и были отправлены пользователем.
5. Метод ISupportRequestEmployeeService.closeRequest должен менять флаг isActive на false.
6. Оповещения должны быть реализованы через механизм EventEmitter.

Должно быть оформлено в виде отдельного NestJS-модуля.

Если пользователь не аутентифицирован или его роль client, то при поиске всегда должен использоваться флаг isEnabled: true.

Основной API для поиска номеров.

GET /api/common/hotel-rooms

• limit — количество записей в ответе;
• offset — сдвиг от начала списка;
• hotel — ID гостиницы для фильтра.

[
  {
    "id": string,
    "description": string,
    "images": [string],
    "hotel": {
      "id": string,
      "title": string
    }
  }
]

Доступно всем пользователям, включая неаутентифицированных.

Получение подробной информации о номере.

GET /api/common/hotel-rooms/:id

Отсутствуют.

{
  "id": string,
  "description": string,
  "images": [string],
  "hotel": {
    "id": string,
    "title": string,
    "description": string
  }
}

Доступно всем пользователям, включая неаутентифицированных.

Добавление гостиницы администратором.

POST /api/admin/hotels/

{
  "title": string,
  "description": string
}

{
  "id": string,
  "title": string,
  "description": string
}

Доступно только аутентифицированным пользователям с ролью admin.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не admin.

Получение списка гостиниц администратором.

GET /api/admin/hotels/

• limit - количество записей в ответе;
• offset - сдвиг от начала списка.

{
  "id": string,
  "title": string,
  "description": string
}

Доступно только аутентифицированным пользователям с ролью admin.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не admin.

Изменение описания гостиницы администратором.

PUT /api/admin/hotels/:id

{
  "title": string,
  "description": string
}

{
  "id": string,
  "title": string,
  "description": string
}

Доступно только аутентифицированным пользователям с ролью admin.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не admin.

Добавление номера гостиницы администратором.

POST /api/admin/hotel-rooms/

Этот запрос предполагает загрузку файлов и должен использовать формат multipart/form-data.

description: string
hotelId: string
images[]: File

{
  "id": string,
  "description": string,
  "images": [string],
  "isEnabled": boolean,
  "hotel": {
    "id": string,
    "title": string,
    "description": string
  }
}

Доступно только аутентифицированным пользователям с ролью admin.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не admin.

Изменение описания номера гостиницы администратором.

PUT /api/admin/hotel-rooms/:id

Этот запрос предполагает загрузку файлов и дожен использовать формат multipart/form-data.

description: string
hotelId: string
isEnabled: boolean
images[]: File | string

При обновлении может быть отправлен одновременно список ссылок на уже загруженные картинки и список файлов с новыми картинками.

При использовании multer список загруженных файлов можно получить через @UploadedFiles(). Этот список нужно объединить со списком, который пришёл в body.

{
  "id": string,
  "description": string,
  "images": [string],
  "isEnabled": boolean,
  "hotel": {
    "id": string,
    "title": string,
    "description": string
  }
}

Доступно только аутентифицированным пользователям с ролью admin.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не admin.

Должно быть оформлено в виде отдельного NestJS-модуля.

Создаёт бронь на номер на выбранную дату для текущего пользователя.

POST /api/client/reservations

{
  "hotelRoom": string,
  "startDate": string,
  "endDate": string
}

{
  "startDate": string,
  "endDate": string,
  "hotelRoom": {
    "description": string,
    "images": [string]
  },
  "hotel": {
    "title": string,
    "description": string
  }
}

Доступно только аутентифицированным пользователям с ролью client.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не client;
• 400 - если номера с указанным ID не существует или он отключён.

Список броней текущего пользователя.

GET /api/client/reservations

[
  {
    "startDate": string,
    "endDate": string,
    "hotelRoom": {
      "description": string,
      "images": [string]
    },
    "hotel": {
      "title": string,
      "description": string
    }
  }
]

Доступно только аутентифицированным пользователям с ролью client.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не client.

Отменяет бронь пользователя.

DELETE /api/client/reservations/:id

Пустой ответ.

Доступно только аутентифицированным пользователям с ролью client.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не client;
• 403 - если ID текущего пользователя не совпадает с ID пользователя в брони;
• 400 - если брони с указанным ID не существует.

Список броней конкретного пользователя.

GET /api/manager/reservations/:userId

[
  {
    "startDate": string,
    "endDate": string,
    "hotelRoom": {
      "description": string,
      "images": [string]
    },
    "hotel": {
      "title": string,
      "description": string
    }
  }
]

Доступно только аутентифицированным пользователям с ролью manager.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не manager.

Отменяет бронь пользователя по id брони.

DELETE /api/manager/reservations/:id

Пустой ответ.

Доступно только аутентифицированным пользователям с ролью manager.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не manager;
• 400 - если брони с указанным ID не существует.

Должно быть оформлено в виде отдельного NestJS-модуля.

Модуль «Аутентификация и авторизация» предназначен для:

• управления сессией пользователя,
• регистрации пользователей.

Хранение сессии должно реализовываться посредством библиотеки passport.js с хранением сессии в памяти приложения.

Аутентификация пользователя производится с помощью модуля «Пользователи». Каждому пользователю назначается одна из ролей - клиент, администратор, консультант.

Стартует сессию пользователя и выставляет Cookies.

POST /api/auth/login

{
  "email": string,
  "password": string
}

{
  "email": string,
  "name": string,
  "contactPhone": string
}

Доступно только не аутентифицированным пользователям.

• 401 - если пользователя с указанным email не существует или пароль неверный.

Завершает сессию пользователя и удаляет Cookies.

POST /api/auth/logout

Пустой ответ.

Доступно только аутентифицированным пользователям.

Позволяет создать пользователя с ролью client в системе.

POST /api/client/register

{
  "email": string,
  "password": string,
  "name": string,
  "contactPhone": string
}

{
  "id": string,
  "email": string,
  "name": string
}

Доступно только не аутентифицированным пользователям.

• 400 - если email уже занят.

Позволяет пользователю с ролью admin создать пользователя в системе.

POST /api/admin/users/

{
  "email": string,
  "password": string,
  "name": string,
  "contactPhone": string,
  "role": string
}

{
  "id": string,
  "email": string,
  "name": string,
  "contactPhone": string,
  "role": string
}

Доступно только пользователям с ролью admin.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не admin.

Позволяет пользователю с ролью admin создать пользователя в системе.

GET /api/admin/users/
GET /api/manager/users/

• limit - количество записей в ответе;
• offset - сдвиг от начала списка;
• name - фильтр по полю;
• email - фильтр по полю;
• contactPhone - фильтр по полю.

[
  {
    "id": string,
    "email": string,
    "name": string,
    "contactPhone": string
  }
]

GET /api/admin/users/

Доступно только пользователям с ролью admin.

GET /api/manager/users/

Доступно только пользователям с ролью manager.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не подходит.

Позволяет пользователю с ролью client создать обращение в техподдержку.

POST /api/client/support-requests/

{
  "text": string
}

[
  {
    "id": string,
    "createdAt": string,
    "isActive": boolean,
    "hasNewMessages": boolean
  }
]

Доступно только пользователям с ролью client.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не подходит.

Позволяет пользователю с ролью client получить список обращений для текущего пользователя.

GET /api/client/support-requests/

• limit - количество записей в ответе;
• offset - сдвиг от начала списка;
• isActive - фильтр по полю.

[
  {
    "id": string,
    "createdAt": string,
    "isActive": boolean,
    "hasNewMessages": boolean
  }
]

Доступно только пользователям с ролью client.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не подходит.

Позволяет пользователю с ролью manager получить список обращений от клиентов.

GET /api/manager/support-requests/

• limit - количество записей в ответе;
• offset - сдвиг от начала списка;
• isActive - фильтр по полю.

[
  {
    "id": string,
    "createdAt": string,
    "isActive": boolean,
    "hasNewMessages": boolean,
    "client": {
      "id": string,
      "name": string,
      "email": string,
      "contactPhone": string
    }
  }
]

Доступно только пользователям с ролью manager.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не подходит.

Позволяет пользователю с ролью manager или client получить все сообщения из чата.

GET /api/common/support-requests/:id/messages

[
  {
    "id": string,
    "createdAt": string,
    "text": string,
    "readAt": string,
    "author": {
      "id": string,
      "name": string
    }
  }
]

Доступно только пользователям с ролью manager и пользователю с ролью client, который создал обращение.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не подходит.

Позволяет пользователю с ролью manager или client отправлять сообщения в чат.

POST /api/common/support-requests/:id/messages

{
  "text": string
}

[
  {
    "id": string,
    "createdAt": string,
    "text": string,
    "readAt": string,
    "author": {
      "id": string,
      "name": string
    }
  }
]

Доступно только пользователям с ролью manager и пользователю с ролью client, который создал обращение.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не подходит.

Позволяет пользователю с ролью manager или client отправлять отметку, что сообщения прочитаны.

POST /api/common/support-requests/:id/messages/read

{
  "createdBefore": string
}

{
  "success": true
}

Доступно только пользователям с ролью manager и пользователю с ролью client, который создал обращение.

• 401 - если пользователь не аутентифицирован;
• 403 - если роль пользователя не подходит.

Позволяет пользователю с ролью manager или client получать новые сообщения в чате через WebSocket.

message: subscribeToChat payload: chatId

{
  "id": string,
  "createdAt": string,
  "text": string,
  "readAt": string,
  "author": {
    "id": string,
    "name": string
  }
}

Доступно только пользователям с ролью manager и пользователю с ролью client, который создал обращение.

Для запуска приложения в корне проекта должны находиться следующие файлы:

• package.json и package-lock.json с описанными зависимостями,
• Dockerfile для сборки образа приложения,
• docker-compose.yaml с сервисом приложения и сервисом MondoDB,
• README.me с описанием проекта и вариантами его запуска.

Настройка параметров приложения должна производиться через переменные окружения. Это требование как для запуска в окружении хоста, так и при работе с Docker.

Список переменных окружения должен быть описан в файле .env-example. Этот файл не должен содержать значений. Пример файла:

HTTP_HOST=
HTTP_PORT=
MONGO_URL=

Для запуска приложения должен использоваться скрипт npm start, описанный в package.json.