Class Bot<TUserData>

Example

// Создание бота для Telegram
const bot = new Bot(T_TELEGRAM, MyController);

// Создание бота для VK
const bot = new Bot(T_VK, MyController);

// Создание бота для Алисы
const bot = new Bot(T_ALISA, MyController);
Copy

Example

Простая команда со словами:

appContext.addCommand(
  'greeting',
  ['привет', 'здравствуй'],
  (cmd, ctrl) => {
    if (ctrl) ctrl.text = 'Здравствуйте!';
  }
);
Copy

Example

Команда с регулярными выражениями:

// Обработка чисел от 1 до 999
bot.addCommand(
  'number',
  ['\\b([1-9]|[1-9][0-9]|[1-9][0-9][0-9])\\b'],
  (cmd, ctrl) => {
    if (ctrl) ctrl.text = `Вы ввели число: ${cmd}`;
  },
  true  // включаем поддержку регулярных выражений
);
Copy

Библиотека проверяет регулярные выражения на ReDoS и логирует предупреждения по необходимости

Example

Команда с доступом к состоянию:

bot.addCommand(
  'stats',
  ['статистика'],
  async (cmd, ctrl) => {
    if (ctrl) {
      // Доступ к пользовательским данным
      const visits = ctrl.userData?.visits || 0;
      ctrl.text = `Вы использовали бота ${visits} раз`;

      // Доступ к кнопкам и другим UI элементам
      ctrl.buttons
        .addBtn('Сбросить статистику')
        .addBtn('Закрыть');
    }
  }
);
Copy

Example

// Закрытие сервера
bot.close();
Copy

Example

class MyController extends BotController {
  public action(intentName: string): void {
    switch (intentName) {
      case 'greeting':
        this.text = 'Привет!';
        break;
      case 'help':
        this.text = 'Чем могу помочь?';
        break;
    }
  }
}

bot.initBotController(new MyController());
Copy

Example

// Обработка запроса
const result = await bot.run();
console.log(result);

// Обработка с пользовательским классом
const result = await bot.run(MyBotClass);
Copy

Example

// Конфигурация с базой данных
bot.setAppConfig({
  db: {
    host: 'localhost',
    database: 'bot_db',
    user: 'user',
    pass: 'password'
  }
});


@remarks
Важно! Чувствительные данные рекомендуется сохранять в .env файл, передав путь к нему:
```typescript
bot.setAppConfig({
    env: './.env', // путь до файла
});
Copy

Example

// Установка текстового сообщения
bot.setContent('Привет!');

// Установка JSON-данных
bot.setContent({
  request: {
    command: 'привет',
    original_utterance: 'Привет, бот!'
  }
});
Copy

Example

// Базовая настройка
bot.setPlatformParams({
  intents: [{
    name: 'help',
    slots: ['помощь', 'справка']
  }],
});

@remarks
Важно! Чувствительные данные рекомендуется сохранять в .env файл, передав путь к нему:
```typescript
bot.setAppConfig({
    env: './.env', // путь до файла
});
Copy

Example

// Запуск сервера на localhost:3000
bot.start('localhost', 3000);

// Запуск с пользовательским классом
bot.start('localhost', 3000, MyBotClass);
Copy

Example

// Глобальный middleware (для всех платформ)
bot.use(async (ctx, next) => {
  console.log('Запрос от:', ctx.appType);
  await next();
});
Copy

Example

// Только для Алисы
bot.use('alisa', async (ctx, next) => {
  if (!ctx.appContext.requestObject?.session?.user_id) {
    ctx.text = 'Некорректный запрос';
    ctx.isEnd = true;
    // next() не вызывается → action() не запускается
    return;
  }
  await next();
});
Copy

Example

// Express
import express from 'express';
const app = express();
app.use(express.json({ type: '*/*' })); // важно для Алисы/Сбера

const bot = new Bot('alisa');
bot.initBotController(MyController);
bot.setAppConfig({...});

app.post('/webhook', (req, res) => bot.webhookHandle(req, res));
Copy