Стек: HTML, SCSS, TS, Vite
Структура проекта:
- src/ — исходные файлы проекта
- src/components/ — классы приложения
- src/components/base/ — базовые классы
- src/components/Models/ — модели данных
- src/components/View/ — классы представления
- src/types/ — типы и интерфейсы
- src/utils/ — утилиты и константы
Важные файлы:
- index.html — HTML-файл главной страницы
- src/types/index.ts — файл с типами
- src/main.ts — точка входа приложения
- src/scss/styles.scss — корневой файл стилей
- src/utils/constants.ts — файл с константами
- src/utils/utils.ts — файл с утилитами
Перед первым запуском скопируйте файл .env.example в .env в корне проекта. Если .env уже настроен, заменять его не нужно.
В .env должен быть указан адрес сервера:
VITE_API_ORIGIN=https://larek-api.nomoreparties.coДля установки и запуска проекта необходимо выполнить команды
npm install
npm run dev
или
yarn
yarn dev
npm run build
или
yarn build
«Web-Larёk» — это интернет-магазин с товарами для веб-разработчиков, где пользователи могут просматривать товары, добавлять их в корзину и оформлять заказы. Сайт предоставляет удобный интерфейс с модальными окнами для просмотра деталей товаров, управления корзиной и выбора способа оплаты, обеспечивая полный цикл покупки с отправкой заказов на сервер.
Код приложения разделен на слои согласно парадигме MVP (Model-View-Presenter), которая обеспечивает четкое разделение ответственности между классами слоев Model и View. Каждый слой несет свой смысл и ответственность:
Model - слой данных, отвечает за хранение и изменение данных.
View - слой представления, отвечает за отображение данных на странице.
Presenter - презентер содержит основную логику приложения и отвечает за связь представления и данных.
Взаимодействие между классами обеспечивается использованием событийно-ориентированного подхода. Модели и Представления генерируют события при изменении данных или взаимодействии пользователя с приложением, а Презентер обрабатывает эти события используя методы как Моделей, так и Представлений.
Является базовым классом для всех компонентов интерфейса.
Класс является дженериком и принимает в переменной T тип данных, которые могут быть переданы в метод render для отображения.
Конструктор:
constructor(container: HTMLElement) - принимает ссылку на DOM элемент за отображение, которого он отвечает.
Поля класса:
container: HTMLElement - поле для хранения корневого DOM элемента компонента.
Методы класса:
render(data?: Partial<T>): HTMLElement - Главный метод класса. Он принимает данные, которые необходимо отобразить в интерфейсе, записывает эти данные в поля класса и возвращает ссылку на DOM-элемент. Предполагается, что в классах, которые будут наследоваться от Component будут реализованы сеттеры для полей с данными, которые будут вызываться в момент вызова render и записывать данные в необходимые DOM элементы.
setImage(element: HTMLImageElement, src: string, alt?: string): void - утилитарный метод для модификации DOM-элементов <img>
Содержит в себе базовую логику отправки запросов.
Конструктор:
constructor(baseUrl: string, options: RequestInit = {}) - В конструктор передается базовый адрес сервера и опциональный объект с заголовками запросов.
Поля класса:
baseUrl: string - базовый адрес сервера
options: RequestInit - объект с заголовками, которые будут использованы для запросов.
Методы:
get<T extends object>(uri: string): Promise<T> - выполняет GET запрос на переданный в параметрах ендпоинт и возвращает промис с объектом, которым ответил сервер
post<T extends object>(uri: string, data: object, method: ApiPostMethods = 'POST'): Promise<T> - принимает объект с данными, которые будут переданы в JSON в теле запроса, и отправляет эти данные на ендпоинт переданный как параметр при вызове метода. По умолчанию выполняется POST запрос, но метод запроса может быть переопределен заданием третьего параметра при вызове.
handleResponse<T>(response: Response): Promise<T> - защищенный метод проверяющий ответ сервера на корректность и возвращающий объект с данными полученный от сервера или отклоненный промис, в случае некорректных данных.
Брокер событий связывает модели данных, представления и Презентер. Реализует интерфейс IEvents.
Конструктор:
- constructor() — создаёт пустую коллекцию подписок.
Поля класса:
- _events: Map<EventName, Set> — названия событий и их обработчики.
Методы класса:
- on(eventName: EventName, callback: (event: T) => void): void — подписывает обработчик на событие;
- off(eventName: EventName, callback: Subscriber): void — удаляет указанный обработчик;
- emit(eventName: string, data?: T): void — вызывает обработчики события и передаёт им данные;
- onAll(callback: (event: EmitterEvent) => void): void — подписывает обработчик на все события;
- offAll(): void — удаляет все подписки;
- trigger(eventName: string, context?: Partial): (event?: object) => void — возвращает обработчик, который генерирует событие с переданными данными.
Типы базового брокера находятся в src/components/base/Events.ts:
- EventName = string | RegExp — название события или регулярное выражение;
- Subscriber = Function — обработчик события;
- EmitterEvent — объект с полями eventName: string и data: unknown;
- IEvents — интерфейс брокера с методами on, emit и trigger. В интерфейсе trigger возвращает обработчик (data: T) => void.
В приложении используются две основные сущности данных: товар и покупатель.
Интерфейс IProduct описывает товар, отображаемый в каталоге интернет-магазина.
interface IProduct { id: string; description: string; image: string; title: string; category: string; price: number | null; }
Поля интерфейса:
- id: string — уникальный идентификатор товара;
- description: string — описание товара;
- image: string — путь к изображению товара;
- title: string — название товара;
- category: string — категория товара;
- price: number | null — цена товара. Значение null означает, что товар недоступен для покупки.
Тип TPayment описывает доступные способы оплаты.
type TPayment = 'card' | 'cash';
Интерфейс IBuyer описывает данные покупателя, необходимые для оформления заказа.
interface IBuyer { payment: TPayment; email: string; phone: string; address: string; }
Поля интерфейса:
- payment: TPayment — выбранный способ оплаты;
- email: string — электронная почта покупателя;
- phone: string — телефон покупателя;
- address: string — адрес доставки.
Типы приложения находятся в src/types/index.ts.
- ApiPostMethods = 'POST' | 'PUT' | 'DELETE' — методы отправки данных;
- IApi — интерфейс объекта для запросов к серверу. Содержит методы get(uri: string): Promise и post(uri: string, data: object, method?: ApiPostMethods): Promise;
- IProductsResponse — ответ с каталогом: total: number — количество товаров, items: IProduct[] — массив товаров;
- IOrder — данные заказа. Содержит поля IBuyer, total: number — общую стоимость и items: string[] — идентификаторы товаров;
- IOrderResponse — ответ на оформление заказа: id: string — идентификатор заказа, total: number — итоговая стоимость.
- IPage — данные страницы: catalog: HTMLElement[] — карточки каталога, counter: number — счётчик корзины;
- IModal — содержимое модального окна: content: HTMLElement;
- TCard — название и цена из IProduct: title: string, price: number | null;
- TCardCatalog — поля title, price, image и category из IProduct;
- TCardPreview — поля title, price, image, category и description из IProduct, а также buttonText: string и disabled: boolean для кнопки;
- TCardBasket — поля TCard и index: number — номер товара в корзине;
- IBasketView — содержимое корзины: items: HTMLElement[] — карточки, total: number — общая стоимость;
- IFormState — состояние формы: valid: boolean — доступность отправки, errors: string — сообщение об ошибках;
- TOrderForm — address: string из IBuyer и payment: TPayment | null. Значение null означает, что оплата ещё не выбрана;
- TContactsForm — поля email и phone из IBuyer;
- TSuccess — поле total: number из IOrderResponse.
- TProductEvent — поле id: string из IProduct. Используется при выборе товара, покупке и удалении из корзины;
- IFieldChange<T = string> — изменение поля формы: field: string — имя поля, value: T — новое значение. Для текстовых полей используется string, для способа оплаты — TPayment.
Класс Products отвечает за хранение каталога товаров и товара, выбранного пользователем для подробного просмотра.
Конструктор:
- constructor(events: IEvents) — принимает брокер событий.
Поля класса:
- events: IEvents — брокер событий.
- items: IProduct[] — массив всех товаров каталога;
- selectedItem: IProduct | null — товар, выбранный для подробного отображения. Если товар не выбран, содержит null.
Методы класса:
- setItems(items: IProduct[]): void — сохраняет массив товаров и генерирует событие products:changed;
- getItems(): IProduct[] — возвращает массив всех товаров;
- getItem(id: string): IProduct | undefined — возвращает товар с указанным идентификатором. Если товар не найден, возвращает undefined;
- setSelectedItem(item: IProduct): void — сохраняет выбранный товар и генерирует событие product:selected;
- getSelectedItem(): IProduct | null — возвращает выбранный товар или null, если товар не выбран.
Класс Basket отвечает за хранение и изменение списка товаров, выбранных покупателем для покупки.
Конструктор:
- constructor(events: IEvents) — принимает брокер событий.
Поля класса:
- items: IProduct[] — массив товаров, добавленных в корзину;
- events: IEvents — брокер событий.
Методы класса:
- getItems(): IProduct[] — возвращает массив товаров в корзине;
- addItem(item: IProduct): void — добавляет товар, если его ещё нет в корзине, и генерирует событие basket:changed;
- removeItem(item: IProduct): void — удаляет товар из корзины и генерирует событие basket:changed;
- clear(): void — очищает корзину и генерирует событие basket:changed;
- getTotal(): number — возвращает общую стоимость товаров в корзине;
- getCount(): number — возвращает количество товаров в корзине;
- hasItem(id: string): boolean — проверяет наличие товара с переданным идентификатором в корзине.
Класс Buyer отвечает за хранение, изменение, очистку и валидацию данных покупателя, необходимых для оформления заказа.
Конструктор:
- constructor(events: IEvents) — принимает брокер событий.
Поля класса:
- payment: TPayment | null — выбранный способ оплаты. До выбора способа оплаты содержит null;
- address: string — адрес доставки;
- email: string — электронная почта покупателя;
- phone: string — телефон покупателя;
- events: IEvents — брокер событий.
Методы класса:
- setData(data: Partial): void — сохраняет переданные данные покупателя, не удаляя остальные значения, и генерирует событие buyer:changed;
- getData(): Partial — возвращает сохранённые данные покупателя;
- clear(): void — очищает данные покупателя и генерирует событие buyer:changed;
- validate(): Partial<Record<keyof IBuyer, string>> — проверяет данные покупателя и возвращает объект с сообщениями об ошибках. Если поле заполнено корректно, соответствующее свойство в объекте ошибок отсутствует.
Класс WebLarekApi отвечает за взаимодействие приложения с сервером интернет-магазина. Для выполнения HTTP-запросов класс использует экземпляр, соответствующий интерфейсу IApi, переданный через конструктор. Таким образом, работа с сервером реализована с использованием композиции.
Конструктор:
- constructor(api: IApi) — принимает объект для выполнения запросов к серверу.
Поля класса:
- api: IApi — объект, предоставляющий методы get и post для взаимодействия с сервером.
Методы класса:
- getProducts(): Promise — выполняет GET-запрос на эндпоинт /product/ и возвращает объект с общим количеством товаров и массивом товаров каталога;
- createOrder(order: IOrder): Promise — принимает данные заказа, выполняет POST-запрос на эндпоинт /order/ и возвращает объект с идентификатором созданного заказа и итоговой стоимостью покупки.
Классы представления отвечают за отображение данных и генерируют события при действиях пользователя. Презентер обрабатывает эти события и передаёт компонентам данные для отображения.
Все компоненты наследуют метод render от Component. В конструкторы передаётся DOM-элемент компонента. Для уведомления о действиях пользователя используется брокер событий или обработчик, переданный через конструктор.
Класс Page отвечает за каталог на главной странице, счётчик товаров и кнопку открытия корзины.
Наследуется от Component.
Конструктор:
- constructor(container: HTMLElement, events: IEvents).
Поля класса:
- gallery: HTMLElement — контейнер каталога;
- basketButton: HTMLButtonElement — кнопка корзины;
- basketCounter: HTMLElement — счётчик товаров.
Сеттеры:
- set catalog(items: HTMLElement[]) — отображает карточки каталога;
- set counter(value: number) — обновляет счётчик корзины.
События:
- basket:open — нажатие на кнопку корзины.
Класс Card содержит общую функциональность трёх видов карточек: отображение названия и цены товара. Также содержит общие методы для изображения и категории, которые используют CardCatalog и CardPreview.
Наследуется от Component. Принимает тип данных T, основанный на TCard.
Конструктор:
- constructor(container: HTMLElement) — принимает DOM-элемент карточки.
Поля класса:
- titleElement: HTMLElement — название товара;
- priceElement: HTMLElement — цена товара.
Сеттеры:
- set title(value: string) — отображает название;
- set price(value: number | null) — отображает цену. При null выводит «Бесценно».
Защищённые методы:
- setCardImage(element: HTMLImageElement, value: string): void — устанавливает изображение и использует название товара как alt;
- setCategory(element: HTMLElement, value: string): void — отображает название категории и меняет её CSS-класс через categoryMap.
Класс CardCatalog отображает карточку в каталоге. Использует шаблон card-catalog.
Наследуется от Card.
Конструктор:
- constructor(container: HTMLElement, onClick: () => void) — принимает DOM-элемент карточки и обработчик нажатия.
Поля класса:
- imageElement: HTMLImageElement — изображение товара;
- categoryElement: HTMLElement — категория товара.
Сеттеры:
- set image(value: string) — устанавливает изображение;
- set category(value: string) — отображает категорию и задаёт её CSS-класс из categoryMap.
Название и цена устанавливаются через сеттеры класса Card.
При нажатии вызывается переданный обработчик, который генерирует событие product:select с id товара.
Класс CardPreview отображает подробную информацию о товаре. Использует шаблон card-preview.
Наследуется от Card.
Конструктор:
- constructor(container: HTMLElement, onClick: () => void) — принимает DOM-элемент карточки и обработчик нажатия на кнопку.
Поля класса:
- imageElement: HTMLImageElement — изображение товара;
- categoryElement: HTMLElement — категория товара;
- descriptionElement: HTMLElement — описание товара;
- buttonElement: HTMLButtonElement — кнопка действия с товаром.
Сеттеры:
- set image(value: string) — устанавливает изображение;
- set category(value: string) — отображает категорию и задаёт её CSS-класс из categoryMap;
- set description(value: string) — отображает описание;
- set buttonText(value: string) — устанавливает текст кнопки;
- set disabled(value: boolean) — управляет блокировкой кнопки.
Презентер передаёт текст кнопки: «Купить», «Удалить из корзины» или «Недоступно». Для товара без цены кнопка блокируется.
При нажатии на кнопку вызывается переданный обработчик, который генерирует событие product:action с id товара.
Класс CardBasket отображает товар в корзине. Использует шаблон card-basket.
Наследуется от Card.
Конструктор:
- constructor(container: HTMLElement, onClick: () => void) — принимает DOM-элемент карточки и обработчик удаления.
Поля класса:
- indexElement: HTMLElement — порядковый номер товара;
- deleteButton: HTMLButtonElement — кнопка удаления.
Сеттеры:
- set index(value: number) — отображает номер товара.
При нажатии на кнопку удаления вызывается переданный обработчик, который генерирует событие basket:remove с id товара.
Класс BasketView отображает содержимое корзины. Использует шаблон basket.
Наследуется от Component.
Конструктор:
- constructor(container: HTMLElement, events: IEvents).
Поля класса:
- listElement: HTMLElement — список товаров;
- totalElement: HTMLElement — общая стоимость;
- orderButton: HTMLButtonElement — кнопка оформления.
Сеттеры:
- set items(items: HTMLElement[]) — отображает карточки корзины и блокирует кнопку оформления, если список пуст;
- set total(value: number) — отображает общую стоимость, полученную от Презентера.
Для пустого списка надпись «Корзина пуста» выводится существующими стилями.
События:
- order:open — нажатие на кнопку оформления заказа.
Класс Form содержит общую функциональность форм: обработку ввода и отправки, вывод ошибок и управление кнопкой отправки.
Наследуется от Component.
Конструктор:
- constructor(container: HTMLFormElement, events: IEvents).
Поля класса:
- submitButton: HTMLButtonElement — кнопка отправки;
- errorsElement: HTMLElement — сообщения об ошибках;
- events: IEvents — брокер событий.
Сеттеры:
- set valid(value: boolean) — управляет доступностью кнопки отправки;
- set errors(value: string) — отображает ошибки.
Методы класса:
- onInputChange(field: string, value: string): void — генерирует событие изменения поля с данными field и value.
При отправке формы отменяется перезагрузка страницы и генерируется событие отправки. Результат проверки данных форма получает от Презентера.
События:
- <имя формы>.<имя поля>:change — изменение поля;
- <имя формы>:submit — отправка формы.
Класс OrderForm отвечает за выбор оплаты и ввод адреса. Использует шаблон order.
Наследуется от Form.
Конструктор:
- constructor(container: HTMLFormElement, events: IEvents).
Поля класса:
- paymentButtons: HTMLButtonElement[] — кнопки способов оплаты;
- addressInput: HTMLInputElement — поле адреса.
Сеттеры:
- set payment(value: TPayment | null) — выделяет выбранный способ оплаты или снимает выделение при null;
- set address(value: string) — устанавливает адрес.
События:
- order.payment:change — выбор оплаты;
- order.address:change — изменение адреса;
- order:submit — отправка первой формы.
События изменения передают название поля в field и новое значение в value.
Класс ContactsForm отвечает за ввод почты и телефона. Использует шаблон contacts.
Наследуется от Form.
Конструктор:
- constructor(container: HTMLFormElement, events: IEvents).
Поля класса:
- emailInput: HTMLInputElement — поле почты;
- phoneInput: HTMLInputElement — поле телефона.
Сеттеры:
- set email(value: string) — устанавливает почту;
- set phone(value: string) — устанавливает телефон.
События:
- contacts.email:change — изменение почты;
- contacts.phone:change — изменение телефона;
- contacts:submit — отправка второй формы.
События изменения передают название поля в field и новое значение в value.
Класс Success отображает сообщение об успешном заказе. Использует шаблон success.
Наследуется от Component.
Конструктор:
- constructor(container: HTMLElement, events: IEvents).
Поля класса:
- descriptionElement: HTMLElement — сообщение со списанной суммой;
- closeButton: HTMLButtonElement — кнопка «За новыми покупками!».
Сеттеры:
- set total(value: number) — отображает сумму заказа.
События:
- success:close — нажатие на кнопку «За новыми покупками!».
Класс Modal отвечает за открытие и закрытие модального окна. Использует элемент modal-container.
Наследуется от Component. Не имеет дочерних классов: содержимое окна передаётся отдельным DOM-элементом.
Конструктор:
- constructor(container: HTMLElement, events: IEvents).
Поля класса:
- contentElement: HTMLElement — контейнер содержимого;
- closeButton: HTMLButtonElement — кнопка закрытия.
Сеттеры:
- set content(value: HTMLElement) — заменяет содержимое окна.
Методы класса:
- open(): void — открывает окно, добавляя класс modal_active;
- close(): void — закрывает окно, удаляя класс modal_active.
События:
- modal:close-request — нажатие на крестик или фон вне содержимого окна. Презентер обрабатывает событие и закрывает окно.
Блокировка прокрутки страницы при открытом окне реализована в существующих стилях.
-
basket:open — генерируется при нажатии на кнопку корзины в шапке страницы.
-
basket:remove — генерируется обработчиком нажатия на кнопку удаления товара из корзины, передаёт id товара.
-
modal:close-request — генерируется при нажатии на крестик или фон модального окна.
-
product:select — генерируется обработчиком нажатия на карточку каталога, передаёт id выбранного товара.
-
product:action — генерируется обработчиком нажатия на кнопку подробной карточки, передаёт id товара.
-
order:open — генерируется при нажатии на кнопку оформления заказа в корзине.
-
order.address:change — изменение адреса в форме заказа, передаёт field и value.
-
order:submit — отправка первой формы заказа.
-
order.payment:change — выбор способа оплаты, передаёт field со значением payment и value со значением card или cash.
-
contacts.email:change — изменение почты, передаёт field и value.
-
contacts.phone:change — изменение телефона, передаёт field и value.
-
contacts:submit — отправка формы контактных данных.
-
success:close — генерируется при нажатии на кнопку «За новыми покупками!» в сообщении об успешном заказе.
-
products:changed — каталог товаров сохранён в модели Products.
-
product:selected — выбранный товар сохранён в модели Products.
-
basket:changed — список товаров в модели Basket обновлён после добавления, удаления или очистки корзины.
-
buyer:changed — данные покупателя обновлены или очищены в модели Buyer.
Презентер реализован в файле src/main.ts без отдельного класса. Он связывает модели данных и компоненты представления через обработчики событий.
В main.ts создаются общий брокер событий, модели данных, компоненты представления и объект WebLarekApi.
При запуске приложения товары загружаются с сервера и сохраняются в модели Products.
Для обновления компонентов используются функции:
- updatePreview(): void — обновляет подробную карточку и состояние её кнопки;
- updateBasket(): void — обновляет список корзины, общую стоимость и счётчик товаров;
- updateForms(): void — отображает данные покупателя, ошибки и доступность кнопок форм.
Обработка событий моделей:
- products:changed — получает товары из модели и отображает карточки каталога;
- product:selected — открывает подробную карточку выбранного товара;
- basket:changed — обновляет корзину, счётчик и кнопку подробной карточки;
- buyer:changed — обновляет данные и состояние форм.
Обработка событий представления:
- product:select — сохраняет выбранный товар в модели Products;
- product:action — добавляет товар в корзину или удаляет его, затем закрывает окно. Товар без цены добавить нельзя;
- basket:remove — удаляет товар из модели Basket;
- basket:open — открывает корзину;
- order:open — открывает первую форму, если корзина не пуста;
- order:submit — открывает форму контактов, если выбрана оплата и заполнен адрес;
- order.payment:change — сохраняет выбранный способ оплаты;
- order.address:change — сохраняет адрес;
- contacts.email:change — сохраняет почту;
- contacts.phone:change — сохраняет телефон;
- contacts:submit — проверяет данные и отправляет заказ на сервер;
- modal:close-request и success:close — закрывают модальное окно.
При отправке заказа Презентер получает данные покупателя из Buyer, список идентификаторов товаров и общую стоимость из Basket. Повторная отправка блокируется до завершения текущего запроса.
После успешного ответа сервера очищаются корзина и данные покупателя. Открывается сообщение Success с суммой из ответа сервера. При ошибке данные сохраняются, а сообщение об ошибке выводится в консоль.
Представление обновляется при обработке событий изменения моделей или при открытии модального окна. Обработчики Презентера не генерируют события.
Для карточек через events.trigger() создаются обработчики, которые передаются в конструкторы компонентов и вызываются при нажатии.