Для упрощения разработки Telegram ботов на TypeScript был создан клиент, полностью типизированный и охватывающий все методы API. Использование нативного fetch для HTTP запросов генерировало много рутинного кода, требовало постоянного обращения к документации и выбора нужных JSON, что подтолкнуло к созданию библиотеки.
Основой стал парсер HTML-документации Telegram API, генерирующий TypeScript типы и интерфейсы. Несмотря на попытки других проектов парсить HTML страницу и создавать OpenAPI артефакт, эти сгенерированные спецификации оказались не очень удобными и корректными. Было решено написать свой парсер HTML страницы и кодогенератор, для того, чтобы сразу сгенерировать TypeScript типы и интерфейсы. Парсер объединяет типы и методы в единую сущность, учитывая минимальные различия между ними.
Библиотека использует сгенерированные типы для обеспечения типизированного API клиента, с функциями, принимающими название и тело метода, автоматически типизируя входные данные. Клиент отправляет HTTP запросы, используя multipart/form-data, и преобразует ответы в соответствующие TypeScript типы, созданные кодогенератором.
Опубликованная в NPM библиотека включает в себя контракты Telegram Bot Api (методы, входные данные, типы результатов) и выходные типы. Это позволяет разработчикам использовать все преимущества TypeScript, такие как автодополнение и проверка типов, при работе с Telegram Bot API.
Изображение носит иллюстративный характер
Основой стал парсер HTML-документации Telegram API, генерирующий TypeScript типы и интерфейсы. Несмотря на попытки других проектов парсить HTML страницу и создавать OpenAPI артефакт, эти сгенерированные спецификации оказались не очень удобными и корректными. Было решено написать свой парсер HTML страницы и кодогенератор, для того, чтобы сразу сгенерировать TypeScript типы и интерфейсы. Парсер объединяет типы и методы в единую сущность, учитывая минимальные различия между ними.
Библиотека использует сгенерированные типы для обеспечения типизированного API клиента, с функциями, принимающими название и тело метода, автоматически типизируя входные данные. Клиент отправляет HTTP запросы, используя multipart/form-data, и преобразует ответы в соответствующие TypeScript типы, созданные кодогенератором.
Опубликованная в NPM библиотека включает в себя контракты Telegram Bot Api (методы, входные данные, типы результатов) и выходные типы. Это позволяет разработчикам использовать все преимущества TypeScript, такие как автодополнение и проверка типов, при работе с Telegram Bot API.
