myteam-bot-sdk

Myteam Bot SDK

Открытый SDK для создания ботов в мессенджере Myteam.

В наличии имеется:

• тайпинги на все ответы сервера согласно официальной документации;
• методы для:
  • обработки команд
  • отправки сообщений
  • обработки кликов по кнопкам
  • и другие
• методы для прямого хождения в API (на основе node-fetch);
• конструктор форматированных сообщений;
• и другое!

Этот проект создавался в свободное время и не имеет отношения к разработчикам Myteam!

Установка

SDK рассчитан для работы в Node 16. Работать в более ранних версиях оно может, но это неточно.

Для установки выполните следующее:

npm i myteam-bot-sdk

Использование

• Документация
• Пример бота: Poll

Разработка

Сборка

npm run build

• TypeScript
• Rollup

Тестирование

Запуск тестов локально:

npm test

• Jest
• ts-jest

Информация о покрытии будет находиться в папке coverage.

Изменение документации

Для запуска документации локально нужно установить docsify-cli:

npm i -g docsify-cli

После этого можно запустить сервер с документацией с помощью команды:

npm run docs

Сервер будет доступен по адресу http://localhost:3000.