Class Bot<TUserData>

Основной класс для работы с ботом Отвечает за инициализацию, конфигурацию и запуск бота Поддерживает различные платформы: Алиса, Маруся, Telegram, VK, Viber и др.

Bot

Example

Создание простого бота:

const bot = new Bot();
bot.initParam({
  intents: [{
    name: 'greeting',
    slots: ['привет', 'здравствуйте']
  }]
});
bot.initBotController(new MyController());

Example

Использование с базой данных:

const bot = new Bot();
bot.setAppConfig({
  db: {
    host: 'localhost',
    database: 'bot_db',
    user: 'user',
    pass: 'password'
  }
});

Example

Создание бота для Telegram:

const bot = new Bot(T_TELEGRAM);
bot.initParam({
  telegram_token: 'YOUR_BOT_TOKEN'
});

Type Parameters

TUserData extends IUserData = IUserData
Тип пользовательских данных, по умолчанию IUserData

Hierarchy (View Summary)

Bot
- BotTest

Index

Constructors

constructor

new Bot<TUserData extends IUserData = IUserData>(
    type?: TAppType,
    botController?: BotController<TUserData>,
    useGlobalState?: boolean,
): Bot<TUserData>
Создает новый экземпляр бота
Type Parameters
- TUserData extends IUserData = IUserData
Parameters
- Optionaltype: TAppType
  Тип платформы (по умолчанию Алиса)
- OptionalbotController: BotController<TUserData>
  Контроллер с логикой
- OptionaluseGlobalState: boolean = false
  Определяет нужно ли использовать глобальное состояние(mmApp). Не рекомендуется использовать.
Returns Bot<TUserData>
Throws
Если не удалось инициализировать бота
Example
```
// Создание бота для Telegram
const bot = new Bot(T_TELEGRAM, new MyController());

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

// Создание бота для Алисы
const bot = new Bot(T_ALISA, new MyController());
```
- Defined in src/core/Bot.ts:217

Properties

`Protected`_appContext

_appContext: AppContext

Контекст приложения

`Protected`_auth

_auth: TBotAuth

Авторизационный токен пользователя. Используется для авторизованных запросов (например, в Алисе)

`Protected`_botController

_botController: BotController<TUserData>

Контроллер с бизнес-логикой приложения. Обрабатывает команды и формирует ответы

See

BotController

`Protected`_content

_content: TBotContent = null

Полученный запрос от пользователя. Может быть JSON-строкой, текстом или null

`Protected`_serverInst

_serverInst: Server<typeof IncomingMessage, typeof ServerResponse> | undefined

Экземпляр HTTP-сервера

Accessors

appType

get appType(): TAppType | null
Возвращает тип платформы

Returns TAppType | null
- Defined in src/core/Bot.ts:247
set appType(appType: TAppType): void
Устанавливает тип платформы
Parameters
- appType: TAppType
Returns void
- Defined in src/core/Bot.ts:240

Methods

`Protected`_getBotClassAndType

_getBotClassAndType(
userBotClass?: TemplateTypeModel | null,
): IBotBotClassAndType
Protected
Определяет тип платформы и возвращает соответствующий класс для обработки
Parameters
- OptionaluserBotClass: TemplateTypeModel | null = null
  Пользовательский класс бота
Returns IBotBotClassAndType
Объект с типом платформы и классом обработчика
Throws
Если не удалось определить тип приложения
Remarks
Метод определяет тип платформы на основе _appContext.appType и возвращает соответствующий класс:
- T_ALISA → Alisa
- T_VK → Vk
- T_Max → Max
- T_TELEGRAM → Telegram
- T_VIBER → Viber
- T_MARUSIA → Marusia
- T_SMARTAPP → SmartApp
- T_USER_APP → Пользовательский класс
- Defined in src/core/Bot.ts:570

addCommand

addCommand<
    TBotController extends
        BotController<IUserData> = BotController<IUserData>,
>(
    commandName: string,
    slots: TSlots,
    cb?: (userCommand: string, botController: TBotController) => string | void,
    isPattern?: boolean,
): Bot
Добавляет команду для обработки пользовательских запросов
Type Parameters
- TBotController extends BotController<IUserData> = BotController<IUserData>
Parameters
- commandName: string
  Уникальный идентификатор команды
- slots: TSlots
  Триггеры для активации команды
  
  Если элемент — строка → ищется как подстрока (text.includes(...)).
  
  Если элемент — RegExp → проверяется как регулярное выражение (.test(text)).
  
  Параметр isPattern учитывается только если в slots нет RegExp.
  
  При наличии хотя бы одного RegExp, isPattern = false игнорируется, и каждый элемент обрабатывается согласно своему типу.
- Optionalcb: (userCommand: string, botController: TBotController) => string | void
  Функция-обработчик команды
- isPattern: boolean = false
  Использовать регулярные выражения (по умолчанию false)
Returns Bot
Example
Простая команда со словами:
```
appContext.addCommand(
  'greeting',
  ['привет', 'здравствуй'],
  (cmd, ctrl) => {
    if (ctrl) ctrl.text = 'Здравствуйте!';
  }
);
```
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  // включаем поддержку регулярных выражений
);
```
Example
Команда с доступом к состоянию:
```
bot.addCommand(
  'stats',
  ['статистика'],
  async (cmd, ctrl) => {
    if (ctrl) {
      // Доступ к пользовательским данным
      const visits = ctrl.userData?.visits || 0;
      ctrl.text = `Вы использовали бота ${visits} раз`;

      // Доступ к кнопкам и другим UI элементам
      ctrl.buttons
        .addBtn('Сбросить статистику')
        .addBtn('Закрыть');
    }
  }
);
```
Remarks
- Команды обрабатываются в порядке добавления
- При isPattern=true используются регулярные выражения JavaScript
- В callback доступен весь функционал BotController
- Можно использовать async функции в callback
- Defined in src/core/Bot.ts:334

clearCommands

clearCommands(): Bot
Удаляет все команды

Returns Bot
- Defined in src/core/Bot.ts:356

close

close(): void
Закрывает HTTP-сервер. Освобождает ресурсы и завершает работу сервера.

Returns void
Example
```
// Закрытие сервера
bot.close();
```
- Defined in src/core/Bot.ts:903

getAppContext

getAppContext(): AppContext
Возвращает контекст приложения

Returns AppContext
- Defined in src/core/Bot.ts:460

initBotController

initBotController(fn: BotController<TUserData>): Bot
Инициализирует контроллер с бизнес-логикой бота Устанавливает контроллер, который будет обрабатывать команды и формировать ответы
Parameters
- fn: BotController<TUserData>
  Контроллер бота
Returns Bot
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());
```
- Defined in src/core/Bot.ts:542

initConfig

initConfig(config: IAppConfig): void
Инициализирует конфигурацию приложения
Parameters
- config: IAppConfig
  Конфигурация приложения
Returns void
Deprecated
See
setAppConfig
- Defined in src/core/Bot.ts:419

initParams

initParams(params: IAppParam): void
Инициализирует параметры приложения
Parameters
- params: IAppParam
  Параметры приложения
Returns void
Deprecated
See
setPlatformParams
- Defined in src/core/Bot.ts:471

initTypeInGet

initTypeInGet(): boolean
Инициализирует тип бота через GET-параметры Если в URL присутствует параметр type с корректным значением, устанавливает соответствующий тип платформы

Returns boolean
true если инициализация прошла успешно
Example
```
// URL: https://bot.example.com?type=telegram
if (bot.initTypeInGet()) {
  console.log('Тип бота успешно инициализирован для Telegram');
}

// URL: https://bot.example.com?type=vk
if (bot.initTypeInGet()) {
  console.log('Тип бота успешно инициализирован для VK');
}
```
- Defined in src/core/Bot.ts:391

removeCommand

removeCommand(commandName: string): Bot
Удаляет команду
Parameters
- commandName: string
  Имя команды
Returns Bot
- Defined in src/core/Bot.ts:348

run

run(userBotClass?: TemplateTypeModel | null): Promise<TRunResult>
Запускает обработку запроса Выполняет основную логику бота и возвращает результат
Parameters
- OptionaluserBotClass: TemplateTypeModel | null = null
  Пользовательский класс бота
Returns Promise<TRunResult>
Результат выполнения бота
Example
```
// Обработка запроса
const result = await bot.run();
console.log(result);

// Обработка с пользовательским классом
const result = await bot.run(new MyBotClass());
```
- Defined in src/core/Bot.ts:685

setAppConfig

setAppConfig(config: IAppConfig): Bot

Задает конфигурацию приложения Устанавливает настройки бота, включая интенты, базу данных и другие параметры

Parameters

config: IAppConfig
Конфигурация приложения

Returns Bot

Example

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


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

setContent

setContent(content: TBotContent): void
Устанавливает контент запроса Используется для передачи данных от пользователя в бота
Parameters
- content: TBotContent
  Контент запроса
Returns void
Example
```
// Установка текстового сообщения
bot.setContent('Привет!');

// Установка JSON-данных
bot.setContent({
  request: {
    command: 'привет',
    original_utterance: 'Привет, бот!'
  }
});
```
- Defined in src/core/Bot.ts:642

setDevMode

setDevMode(isDevMode: boolean): Bot
Устанавливает режим разработки
Parameters
- isDevMode: boolean
  Флаг включения режима разработки
Returns Bot
Remarks
В режиме разработки в консоль выводятся все ошибки и предупреждения
- Defined in src/core/Bot.ts:366

setLogger

setLogger(logger: ILogger | null): void
Позволяет установить свою реализацию для логирования
Parameters
- logger: ILogger | null
Returns void
- Defined in src/core/Bot.ts:264

setPlatformParams

setPlatformParams(params: IAppParam): Bot

Задает параметры для платформ Устанавливает дополнительные параметры для работы бота

Parameters

params: IAppParam
Параметры платформы

Returns Bot

Example

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

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

setUserDbController

setUserDbController(dbController: IDbControllerModel | undefined): Bot
Устанавливает контроллер с базой данных
Parameters
- dbController: IDbControllerModel | undefined
Returns Bot
- Defined in src/core/Bot.ts:510

start

start(
    hostname?: string,
    port?: number,
    userBotClass?: TemplateTypeModel | null,
): Server
Запускает HTTP-сервер для обработки запросов. Создает сервер на указанном хосте и порту
Parameters
- hostname: string = 'localhost'
  Имя хоста
- port: number = 3000
  Порт
- OptionaluserBotClass: TemplateTypeModel | null = null
  Пользовательский класс бота
Returns Server
Example
```
// Запуск сервера на localhost:3000
bot.start('localhost', 3000);

// Запуск с пользовательским классом
bot.start('localhost', 3000, new MyBotClass());
```
- Defined in src/core/Bot.ts:824

usePlatform

usePlatform(appType: TAppType): Bot
Устанавливает тип платформы
Parameters
- appType: TAppType
Returns Bot
- Defined in src/core/Bot.ts:255

Class Bot<TUserData>

Example

Example

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Bot<TUserData>

Throws

Example

Properties

Protected_appContext

Protected_auth

Protected_botController

See

Protected_content

Protected_serverInst

Accessors

appType

Returns TAppType | null

Parameters

Returns void

Methods

Protected_getBotClassAndType

Parameters

Returns IBotBotClassAndType

Throws

Remarks

addCommand

Type Parameters

Parameters

Returns Bot

Example

Example

Example

Remarks

clearCommands

Returns Bot

close

Returns void

Example

getAppContext

Returns AppContext

initBotController

Parameters

Returns Bot

Example

initConfig

Parameters

Returns void

Deprecated

See

initParams

Parameters

Returns void

Deprecated

See

initTypeInGet

Returns boolean

Example

removeCommand

Parameters

Returns Bot

run

Parameters

Returns Promise<TRunResult>

Example

setAppConfig

Parameters

Returns Bot

Example

setContent

`Protected`_appContext

`Protected`_auth

`Protected`_botController

`Protected`_content

`Protected`_serverInst

`Protected`_getBotClassAndType