About

This library was created to resolve navigation proposals for telegram bots.

Quick start

npm i telegram-bot-router node-telegram-bot-api @types/node-telegram-bot-api

import {createRouter, Route} from 'telegram-bot-router';
import TelegramApi from 'node-telegram-bot-api'

interface RouteOneProps {
  text: string;
}

const routeOne: Route<RouteOneProps> = {
  id: 'routeOne',
  initialMessage(props) {
    return [props.text, {}];
  },
  onMessage(_props, _message, {sessionNavigate}) {
    sessionNavigate(routeTwo, {
      anyObject: {
        value: 'value',
      },
    });
  },
  onCallback() {}
};

interface RouteTwoProps {
  anyObject: {
    value: string;
  };
}

const routeTwo: Route<RouteTwoProps> = {
  id: 'routeTwo',
  initialMessage(props) {
    return [props.anyObject.value, {}];
  },
  onMessage(_props, _message, {sessionNavigate}) {
    sessionNavigate(routeOne, {
      text: 'some text',
    });
  },
  onCallback() {}
};

const bot = new TelegramApi(...);

const router = createRouter({
  entryRoute: routeOne,
  routes: [routeTwo],
  tgApiCallbacks: {
    sendMessage: bot.sendMessage.bind(bot),
    answerCallbackQuery: bot.answerCallbackQuery.bind(bot),
  },
});

bot.on('message', router.onMessage);
bot.on('callback_query', router.onCallbackQuery);