telegram-node-bot/lib/routing/TelegramRouter.js

Module for creating Telegram bots.

'use strict'

const TelegramRoute = require('./TelegramRoute')
const AnyCommand = require('./commands/AnyCommand')

class TelegramRouter {
    constructor() {
        /**
         * @type {TelegramRoute[]}
         * @private
         */
        this._routes = []

        /**
         * @type {TelegramBaseController}
         * @private
         */
        this._otherwiseController = null

        this._callbackQueryController = null
        this._inlineQueryController = null
    }


    /**
     * You can pass your command pattern or array of patterns
     * and some child of TelegramBaseController
     *
     * After that any update that satisfies your command
     * will be passed to your controller
     *
     * @param {BaseCommand|BaseCommand[]} commands
     * @param {TelegramBaseController} controller
     * @returns {TelegramRouter}
     */
    when(commands, controller) {
        this._routes.push(new TelegramRoute(commands, controller))

        return this
    }

    /**
     * This child of TelegramBaseController will be called for all updates
     *
     * @param {TelegramBaseController} controller
     * @returns {TelegramRouter}
     */
    any(controller) {
        this._routes.push(new TelegramRoute(new AnyCommand(), controller))

        return this
    }

    /**
     * This child of TelegramBaseController will be called
     * if there is no controller for that update (except controller passed to 'any' method)
     *
     * @param {TelegramBaseController} controller
     * @returns {TelegramRouter}
     */
    otherwise(controller) {
        this._otherwiseController = controller

        return this
    }


    /**
     * This child of TelegramBaseCallbackQueryController will be called for all callback queries
     *
     * @param {TelegramBaseCallbackQueryController} controller
     */
    callbackQuery(controller) {
        this._callbackQueryController = controller
        return this
    }

    /**
     * This child of TelegramBaseCallbackQueryController will be called for all inline queries
     *
     * @param {TelegramBaseInlineQueryController} controller
     * @returns {TelegramRouter}
     */
    inlineQuery(controller) {
        this._inlineQueryController = controller
        return this
    }

    /**
     *
     * @returns {TelegramBaseCallbackQueryController|null}
     */
    get callbackQueryController() {
        return this._callbackQueryController
    }

    /**
     *
     * @returns {TelegramBaseInlineQueryController|null}
     */
    get inlineQueryController() {
        return this._inlineQueryController
    }

    /**
     * @param {Scope} scope
     * @returns { { controller: TelegramBaseController, handler: string }[] }
     */
    controllersForScope(scope) {
        let controllers = []

        this._routes.forEach(route => {
            let command = route.test(scope)

            if (command !== false) {
                let controllerRoutes = route.controller.routes
                let controllerHandler

                if (controllerRoutes && controllerRoutes[command.handlerName]) {
                    controllerHandler = controllerRoutes[command.handlerName]
                }
                else {
                    controllerHandler = 'handle'
                }

                controllers.push({
                    controller: route.controller,
                    handler: controllerHandler
                })
            }
        })

        if (controllers.length === 0 && this._otherwiseController !== null) {
            controllers.push({ controller: this._otherwiseController, handler: 'handle'})
        }

        return controllers
    }
}

module.exports = TelegramRouter