tgbot

type ChainHandler struct {
	Endpoint Handler

	Middlewares Middlewares
	// contains filtered or unexported fields
}

type Configuration struct {
	// UriApi URI адрес и шаблон к API серверу телеграм.
	//	Используется при наличии локального телеграм сервера.
	//	Первый %s - место вставки токена доступа.
	//	Второй %s - место вставки команды API.
	//	Пример: https://tg0.domain.tld/bot%s/%s
	UriApi string `yaml:"UriApi"`

	// UriFile URI адрес и шаблон точки доступа для загрузки файлов.
	//	Первый %s - место вставки токена доступа.
	//	Второй %s - место вставки пути и имени файла.
	//	Пример: https://tg0.domain.tld/file/bot%s/%s
	UriFile string `yaml:"UriFile"`

	// LogoutFlagFile Файл-флаг выполнения команды LogOut для телеграм бота.
	//	Применяется при смене сервера телеграм с официального облака на выделенный сервер и обратно.
	//	После выполнения команды LogOut, API станет не доступным в течение 10 минут, в течении которых очищается
	//	весь файловый кеш на серверах телеграм.
	//	Пример: /run/myservice/telegram-logout.file
	LogoutFlagFile string `yaml:"LogoutFlagFile"`

	// Token Токен телеграм бота.
	//	Регистрация, настройка и выдача токена выполняется через бот @BotFather.
	Token string `yaml:"Token"`

	// Webhook URL адрес для получения вызовов от серверов телеграм.
	//	Если не указан, тогда используется режим опроса серверов телеграм по таймеру.
	//	Если указано "-", тогда получение данных от серверов телеграм отключается.
	Webhook string `yaml:"Webhook"`

	// MiniAppUri Базовый URI адрес размещения приложений телеграм mini app.
	MiniAppUri string `yaml:"MiniAppUri"`

	// DoNotContactUsers Не отправлять информационные сообщения пользователям телеграм бота.
	//	Используется при работе в режиме разработки при использовании реальной базы данных.
	DoNotContactUsers bool `yaml:"DoNotContactUsers"`

	// NetworkFamily Семейство протоколов используемое для транспорта TCP/IP, при установке связи с api.telegram.org.
	// Применяется при проблемах связи на стороне телеграм, часто IPv6 не работает у телеграм.
	// Доступные значения:
	//
	//	"tcp4" - Только семейство протоколов TCP/IP v4 для IPv4.
	//	"tcp6" - Только семейство протоколов TCP/IP v4 для IPv6.
	//	"" - Любой доступный протокол в соответствии с настройками операционной системы.
	NetworkFamily string `yaml:"NetworkFamily"`

	// Proxy Прокси сервер для установки связи с API сервером телеграм.
	Proxy string `yaml:"Proxy"`
}

type Error struct {
	dic.Errors

	// Panic Перехвачена паника: ... ...
	Panic dic.IError

	// Logger Установка функционала журналирования прервана ошибкой: ...
	Logger dic.IError

	// BusUnknownEvent Не обработанное событие шины данных: ...
	BusUnknownEvent dic.IError

	// ProxyError Указан не корректный адрес прокси сервера ..., ошибка: ...
	ProxyError dic.IError

	// SendMessageToUser Отправка сообщения пользователю телеграм прервана ошибкой: ...
	SendMessageToUser dic.IError

	// GetWebhookInfo Загрузка информации о вебхуке телеграм бота прервана ошибкой: ...
	GetWebhookInfo dic.IError

	// WebhookCreate Создание URI для получения webhook прервано ошибкой: ...
	WebhookCreate dic.IError

	// WebhookRegistration Регистрация URI webhook ... прервано ошибкой: ...
	WebhookRegistration dic.IError

	// RegistrationNilObject "Регистрируемый объект не может быть nil."
	RegistrationNilObject dic.IError

	// RegistrationInterface Регистрируемый объект не реализует ни один обязательный интерфейс.
	RegistrationInterface dic.IError

	// SubscriptionFnIncorrect Не корректная подписка %q, ожидался интерфейс: ...
	SubscriptionIncorrect dic.IError
}

type Handler interface {
	ServeTelegram(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type HandlerFunc func(api *tgbotapi.BotAPI, upd *tgbotapi.Update)

type IUpdatesBusinessConnection interface {
	// OnBusinessConnection Бот был подключен к бизнес-аккаунту или отключен от него, или пользователь отредактировал
	// существующее соединение с ботом.
	OnBusinessConnection(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesBusinessMessage interface {
	// OnBusinessMessage Новое сообщение от подключенного корпоративного аккаунта.
	OnBusinessMessage(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesCallbackQuery interface {
	// OnCallbackQuery Новый входящий запрос обратного вызова.
	OnCallbackQuery(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesChannelPost interface {
	// OnChannelPost Новый входящий пост в канале любого типа — текст, фото, стикер и т.д.
	OnChannelPost(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesChatBoost interface {
	// OnChatBoost Добавлена или изменена функция ускорения чата. Чтобы получать эти обновления, бот должен
	// быть администратором чата.
	OnChatBoost(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesChatJoinRequest interface {
	// OnChatJoinRequest Отправлен запрос на присоединение к чату. Чтобы получать эти обновления, бот должен
	// иметь права администратора can_invite_users в чате.
	OnChatJoinRequest(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesChatMember interface {
	// OnChatMember Статус участника чата был обновлен в чате. Чтобы получать такие обновления, бот должен
	// быть администратором чата и явно указать "chat_member" в списке allowed_updates.
	OnChatMember(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesChosenInlineResult interface {
	// OnChosenInlineResult Результат встроенного запроса, который пользователь выбрал и отправил своему собеседнику в чате.
	OnChosenInlineResult(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesDeletedBusinessMessages interface {
	// OnDeletedBusinessMessages Сообщения были удалены из подключенного корпоративного аккаунта.
	OnDeletedBusinessMessages(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesEditedBusinessMessage interface {
	// OnEditedBusinessMessage Новая версия сообщения от подключенного бизнес-аккаунта.
	OnEditedBusinessMessage(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesEditedChannelPost interface {
	// OnEditedChannelPost Новая версия публикации в канале, известная боту и отредактированная.
	OnEditedChannelPost(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesEditedMessage interface {
	// OnEditedMessage Новая версия сообщения, известная боту и отредактированная.
	OnEditedMessage(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesFull interface {
	IUpdatesTelegramUser
	IUpdatesMessageAudio
	IUpdatesMessageDocument
	IUpdatesMessagePhoto
	IUpdatesMessageSticker
	IUpdatesMessageStory
	IUpdatesMessageVideo
	IUpdatesMessageVideoNote
	IUpdatesMessageVoice
	IUpdatesMessageChecklist
	IUpdatesMessageContact
	IUpdatesMessageDice
	IUpdatesMessageGame
	IUpdatesMessagePoll
	IUpdatesMessageVenue
	IUpdatesMessageLocation
	IUpdatesMessageInvoice
	IUpdatesMessage
	IUpdatesEditedMessage
	IUpdatesChannelPost
	IUpdatesEditedChannelPost
	IUpdatesBusinessConnection
	IUpdatesBusinessMessage
	IUpdatesEditedBusinessMessage
	IUpdatesDeletedBusinessMessages
	IUpdatesMessageReaction
	IUpdatesMessageReactionCount
	IUpdatesInlineQuery
	IUpdatesChosenInlineResult
	IUpdatesCallbackQuery
	IUpdatesShippingQuery
	IUpdatesPreCheckoutQuery
	IUpdatesPurchasedPaidMedia
	IUpdatesPoll
	IUpdatesPollAnswer
	IUpdatesMyChatMember
	IUpdatesChatMember
	IUpdatesChatJoinRequest
	IUpdatesChatBoost
	IUpdatesRemovedChatBoost
	IUpdatesManagedBot
}

type IUpdatesInlineQuery interface {
	// OnInlineQuery Новый входящий встроенный запрос.
	OnInlineQuery(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesManagedBot interface {
	OnManagedBot(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessage interface {
	// OnMessage Новое входящее сообщение любого типа — текст, фото, стикер и т.д.
	OnMessage(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageAudio interface {
	// OnMessageAudio Сообщение - это аудиофайл, информация о файле.
	OnMessageAudio(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageChecklist interface {
	// OnMessageChecklist Сообщение - это контрольный список.
	OnMessageChecklist(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageContact interface {
	// OnMessageContact Сообщение - это общий контакт, информация о контакте.
	OnMessageContact(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageDice interface {
	// OnMessageDice Сообщение - это игральная кость со случайным значением.
	OnMessageDice(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageDocument interface {
	// OnMessageDocument Сообщение - это общий файл, информация о файле.
	OnMessageDocument(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageGame interface {
	// OnMessageGame Сообщение - это игра, информация об игре.
	OnMessageGame(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageInvoice interface {
	// OnMessageInvoice Сообщение - это счет на оплату, информация о счете-фактуре.
	OnMessageInvoice(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageLocation interface {
	// OnMessageLocation Сообщение - это общее местоположение, информация о местоположении.
	OnMessageLocation(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessagePhoto interface {
	// OnMessagePhoto Сообщение - это графические файл или файлы.
	OnMessagePhoto(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessagePoll interface {
	// OnMessagePoll Сообщение - это нативный опрос, информация о нем.
	OnMessagePoll(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageReaction interface {
	// OnMessageReaction Пользователь изменил реакцию на сообщение.
	OnMessageReaction(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageReactionCount interface {
	// OnMessageReactionCount Изменены реакции на сообщение с анонимными реакциями.
	OnMessageReactionCount(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageSticker interface {
	// OnMessageSticker Сообщение - это наклейка, информация о наклейке.
	OnMessageSticker(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageStory interface {
	// OnMessageStory Сообщение - это пересланная история.
	OnMessageStory(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageVenue interface {
	// OnMessageVenue Сообщение - это место проведения, информация о месте проведения.
	OnMessageVenue(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageVideo interface {
	// OnMessageVideo Сообщение - это видео, информация о видео.
	OnMessageVideo(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageVideoNote interface {
	// OnMessageVideoNote Сообщение - это видеозапись, информация о видео сообщении.
	OnMessageVideoNote(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMessageVoice interface {
	// OnMessageVoice Сообщение - это голосовое сообщение, информация о файле.
	OnMessageVoice(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesMyChatMember interface {
	// OnMyChatMember Статус участника чата с ботом был обновлен в чате. В личных чатах это обновление отображается
	// только в том случае, если пользователь заблокировал или разблокировал бота.
	OnMyChatMember(api *tgbotapi.BotAPI, upd *tgbotapi.Update, user *tgbotapi.User)
}

type IUpdatesPoll interface {
	// OnPoll Новое состояние опроса. Боты получают только уведомления об опросах, остановленных вручную, и об опросах,
	// отправленных ботом.
	OnPoll(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesPollAnswer interface {
	// OnPollAnswer Пользователь изменил свой ответ в не анонимном опросе. Боты получают новые голоса только в опросах,
	// отправленных ими самими.
	OnPollAnswer(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesPreCheckoutQuery interface {
	// OnPreCheckoutQuery Новый входящий запрос перед оформлением заказа.
	// Содержит полную информацию об оформлении заказа.
	OnPreCheckoutQuery(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesPurchasedPaidMedia interface {
	// OnPurchasedPaidMedia Пользователь приобрел платный контент с полезной нагрузкой, отправленной ботом
	// в чате без канала.
	OnPurchasedPaidMedia(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesRemovedChatBoost interface {
	// OnRemovedChatBoost Буст был удален из чата. Чтобы получать эти обновления, бот должен быть администратором чата.
	OnRemovedChatBoost(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesShippingQuery interface {
	// OnShippingQuery Новый запрос на доставку. Только для счетов с ценой зависящей от доставки.
	OnShippingQuery(api *tgbotapi.BotAPI, upd *tgbotapi.Update)
}

type IUpdatesTelegramUser interface {
	// OnTelegramUser Метод получающий объект пользователя из любого входящего сообщения обновления.
	OnTelegramUser(api *tgbotapi.BotAPI, upd *tgbotapi.Update, user *tgbotapi.User) (err error)
}

type Interface interface {
	// Databuser Встраивание интерфейса шины данных.
	kitTypes.Databuser

	// BusSubscribe Подписка на сообщения из шины данных.
	BusSubscribe()

	// BusUnsubscribe Отписка от сообщений из шины данных.
	BusUnsubscribe()

	// Registration Регистрация объектов, отвечающих за функционал бота.
	// К регистрации допускаются объекты, которые удовлетворяют хотя бы один интерфейс из перечисленных в IUpdatesFull.
	// Регистрируемый объект должен удовлетворять как минимум один интерфейс обновлений.
	//
	// Если регистрируемый объект не удовлетворяет ни одному интерфейсу, тем самым не содержит ни одного
	// метода, тогда функция регистрации вернёт ошибку, а сам объект не будет зарегистрирован.
	Registration(obj any) (err error)

	// Use Подключение промежуточного.
	Use(middlewares ...func(Handler) Handler)

	// Initialization Инициализация и запуск телеграм бота.
	Initialization(ctx context.Context, cfg *Configuration) (err error)

	LogOut() (err error)

	// IsReady Флаг готовности телеграм бота к работе.
	IsReady() bool

	// Errors Справочник всех ошибок пакета.
	Errors() *Error

	// BotLogger Встраивание интерфейса журналирования.
	tgbotapi.BotLogger
}

type Middlewares []func(Handler) Handler

type UpdatesIncomingType string