7 Commits

Author SHA1 Message Date
FrigaT
f29e72a6f2 Добавлен метод удаления сообщения
All checks were successful
CI / build-test (push) Successful in 48s
Release / pack-and-publish (release) Successful in 51s
2026-01-13 20:38:41 +03:00
FrigaT
0089926fb0 Чистка кода
All checks were successful
CI / build-test (push) Successful in 52s
Release / pack-and-publish (release) Successful in 42s
2025-12-24 17:09:15 +03:00
FrigaT
4124e8c554 Убраны старые api 2025-12-24 16:30:43 +03:00
FrigaT
37cb6599ba Новый api отправки сообщений 2025-12-24 08:43:46 +03:00
FrigaT
833d8c80d9 Добавлена документация 2025-12-24 05:55:26 +03:00
FrigaT
41986987b1 чистка кода
All checks were successful
CI / build-test (push) Successful in 1m2s
2025-12-16 16:19:50 +03:00
246a5cb278 Удалено отключение бота
All checks were successful
CI / build-test (push) Successful in 35s
Release / pack-and-publish (release) Successful in 37s
2025-12-10 20:54:18 +03:00
35 changed files with 771 additions and 392 deletions

View File

@@ -0,0 +1,44 @@
namespace BotPages.Core.Abstractions;
/// <summary>
/// Êîíòåéíåð äëÿ àäàïòåð-ñïåöèôè÷íûõ îïöèé, ïîçâîëÿþùèé õðàíèòü ïàðàìåòðû äëÿ íåñêîëüêèõ àäàïòåðîâ.
/// Èñïîëüçóåòñÿ âíóòðè `SendRequest.AdapterOptions`.
/// </summary>
public sealed class AdapterOptionsBag
{
private readonly Dictionary<string, object?> _map = new(StringComparer.OrdinalIgnoreCase);
/// <summary>
/// Óñòàíîâèòü îïöèè äëÿ àäàïòåðà.
/// </summary>
public void Set<T>(string adapterKey, T options)
{
if (adapterKey is null) throw new ArgumentNullException(nameof(adapterKey));
_map[adapterKey] = options;
}
/// <summary>
/// Ïîïðîáîâàòü ïîëó÷èòü îïöèè äëÿ àäàïòåðà.
/// </summary>
public bool TryGet<T>(string adapterKey, out T? options)
{
if (adapterKey is null) throw new ArgumentNullException(nameof(adapterKey));
if (_map.TryGetValue(adapterKey, out var o) && o is T t)
{
options = t;
return true;
}
options = default;
return false;
}
/// <summary>
/// Ïîëó÷èòü îïöèè èëè âåðíóòü null.
/// </summary>
public T? GetOrDefault<T>(string adapterKey)
{
TryGet(adapterKey, out T? v);
return v;
}
}

View File

@@ -1,5 +1,4 @@
using BotPages.Core.Context;
using BotPages.Core.Messaging;
namespace BotPages.Core.Abstractions;
@@ -15,27 +14,14 @@ public interface IMessengerAdapter
Capabilities Capabilities { get; }
/// <summary>
/// Отправить текстовое сообщение в чат.
/// Универсальный метод отправки с использованием общего описания запроса.
/// </summary>
Task<string?> SendTextAsync(string chatId,
string text,
MessageFormat format = MessageFormat.Plain,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
string? messageId = null,
CancellationToken ct = default
);
Task<string?> SendAsync(SendRequest request, CancellationToken ct = default);
/// <summary>
/// Отправить файл в чат.
/// Универсальный метод удаления сообщения.
/// </summary>
Task SendFileAsync(string chatId,
FileDescriptor file,
string? caption = null,
MessageFormat? captionFormat = null,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
CancellationToken ct = default);
Task DeleteAsync(string chatId, string messageId, CancellationToken ct = default);
/// <summary>
/// Создать билдер альбома для отправки медиагруппы.
@@ -51,7 +37,7 @@ public interface IMessengerAdapter
/// <summary>
/// Контракт конфигурации адаптера.
/// </summary>
public interface IMessangerAdapterSetup : IMessengerAdapter
public interface IMessengerAdapterSetup : IMessengerAdapter
{
/// <summary>
/// Запуск работы адаптера

View File

@@ -4,14 +4,14 @@ namespace BotPages.Core.Abstractions;
/// <summary>
/// Фабрика адаптеров мессенджеров.
/// Используется для разрешения конкретного <see cref="IMessangerAdapterSetup"/> по типу мессенджера.
/// Используется для разрешения конкретного <see cref="IMessengerAdapterSetup"/> по типу мессенджера.
/// </summary>
public interface IMessengerAdapterFactory
{
/// <summary>
/// Список зарегистрированных адаптеров.
/// </summary>
Dictionary<string, IMessangerAdapterSetup> Adapters { get; }
Dictionary<string, IMessengerAdapterSetup> Adapters { get; }
/// <summary>
/// Зарегистрировать адаптер для указанного типа мессенджера.
@@ -23,9 +23,9 @@ public interface IMessengerAdapterFactory
/// Экземпляр адаптера, реализующий <see cref="IMessengerAdapter"/>.
/// </param>
/// <returns>
/// Текущий экземпляр <see cref="MultiAdapterFactory"/> для цепочки вызовов.
/// Текущий экземпляр <see cref="IMessengerAdapterFactory"/> для цепочки вызовов.
/// </returns>
IMessengerAdapterFactory Register(string messengerType, IMessangerAdapterSetup adapter);
IMessengerAdapterFactory Register(string messengerType, IMessengerAdapterSetup adapter);
/// <summary>
/// Получить адаптер для указанного мессенджера.

View File

@@ -6,12 +6,12 @@
/// </summary>
public sealed class MultiAdapterFactory : IMessengerAdapterFactory
{
private readonly Dictionary<string, IMessangerAdapterSetup> _adapters = new(StringComparer.OrdinalIgnoreCase);
private readonly Dictionary<string, IMessengerAdapterSetup> _adapters = new(StringComparer.OrdinalIgnoreCase);
/// <summary>
/// Список зарегистрированных адаптеров.
/// </summary>
public Dictionary<string, IMessangerAdapterSetup> Adapters => _adapters;
public Dictionary<string, IMessengerAdapterSetup> Adapters => _adapters;
/// <summary>
/// Зарегистрировать адаптер для указанного типа мессенджера.
@@ -25,7 +25,7 @@ public sealed class MultiAdapterFactory : IMessengerAdapterFactory
/// <returns>
/// Текущий экземпляр <see cref="MultiAdapterFactory"/> для цепочки вызовов.
/// </returns>
public IMessengerAdapterFactory Register(string messengerType, IMessangerAdapterSetup adapter)
public IMessengerAdapterFactory Register(string messengerType, IMessengerAdapterSetup adapter)
{
_adapters[messengerType] = adapter;
return this;

View File

@@ -0,0 +1,42 @@
using BotPages.Core.Messaging;
namespace BotPages.Core.Abstractions;
/// <summary>
/// Óíèâåðñàëüíàÿ ñòðóêòóðà çàïðîñà íà îòïðàâêó ñîîáùåíèÿ/ôàéëà, èñïîëüçóåìàÿ àäàïòåðàìè.
/// </summary>
public sealed class SendRequest
{
/// <summary>Èäåíòèôèêàòîð ÷àòà/ñåññèè â ìåññåíäæåðå.</summary>
public required string ChatId { get; init; }
/// <summary>Òåêñò ñîîáùåíèÿ (åñëè îòïðàâëÿåòñÿ òåêñò).</summary>
public string? Text { get; init; }
/// <summary>Ôîðìàò òåêñòà (HTML/Markdown/Plain).</summary>
public MessageFormat? TextFormat { get; init; }
/// <summary>Inline êíîïêè (ñòðîêè êíîïîê).</summary>
public IEnumerable<IEnumerable<InlineButton>>? Inline { get; init; }
/// <summary>Reply êëàâèàòóðà (ñòðîêè êíîïîê).</summary>
public IEnumerable<IEnumerable<ReplyButton>>? Reply { get; init; }
/// <summary>Id ðåäàêòèðóåìîãî ñîîáùåíèÿ (åñëè ðåäàêòèðóåì).</summary>
public string? MessageId { get; init; }
/// <summary>Ôàéë äëÿ îòïðàâêè (åñëè îòïðàâëÿåòñÿ ôàéë).</summary>
public FileDescriptor? File { get; init; }
/// <summary>Ïîäïèñü äëÿ ôàéëà.</summary>
public string? Caption { get; init; }
/// <summary>Ôîðìàò ïîäïèñè/ïîäïèñè äëÿ ôàéëà.</summary>
public MessageFormat? CaptionFormat { get; init; }
/// <summary>
/// Êîíòåéíåð àäàïòåð-ñïåöèôè÷íûõ îïöèé.
/// Ñîäåðæèò èìåíà/êëþ÷è àäàïòåðîâ è ñîîòâåòñòâóþùèå îáúåêòû îïöèé.
/// </summary>
public AdapterOptionsBag? AdapterOptions { get; init; }
}

View File

@@ -40,7 +40,7 @@ public sealed class BotPagesApp
/// <summary>
/// Добавить адаптер.
/// </summary>
public BotPagesApp AddAdapter(string messengerType, IMessangerAdapterSetup adapter)
public BotPagesApp AddAdapter(string messengerType, IMessengerAdapterSetup adapter)
{
_adapterFactory.Register(messengerType, adapter);
return this;

View File

@@ -1,6 +1,4 @@
using BotPages.Core.Abstractions;
namespace BotPages.Core;
namespace BotPages.Core;
/// <summary>
/// Данные чата.

View File

@@ -1,6 +1,5 @@
using BotPages.Core.Abstractions;
using BotPages.Core.Context;
using BotPages.Core.Messaging;
namespace BotPages.Core;

View File

@@ -1,41 +1,22 @@
using BotPages.Core.Abstractions;
using BotPages.Core.Messaging;
namespace BotPages.Core;
/// <summary>
/// Расширения <see cref="PageContext"/> для работы с <see cref="IMessengerAdapter"/>
/// Расширения <see cref="PageContext"/> для работы с адаптером.
/// Упрощают создание универсального `SendRequest`.
/// </summary>
public static class PageContextAdapterExtensions
{
/// <summary>
/// Отправить текстовое сообщение.
/// Отправить сообщение универсальным запросом через привязанный адаптер.
/// </summary>
public static Task<string?> SendTextAsync(this PageContext ctx,
string text,
MessageFormat format = MessageFormat.Plain,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
string? messageId = null,
CancellationToken ct = default)
=> ctx.Adapter.SendTextAsync(ctx.Update.Chat.Id, text, format, inline, reply, messageId, ct);
public static Task<string?> SendAsync(this PageContext ctx, SendRequest request, CancellationToken ct = default)
=> ctx.Adapter.SendAsync(request, ct);
/// <summary>
/// Отправить файл.
/// Удалить сообщение через привязанный адаптер.
/// </summary>
public static Task SendFileAsync(this PageContext ctx,
FileDescriptor file,
string? caption = null,
MessageFormat? captionFormat = null,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
CancellationToken ct = default
)
=> ctx.Adapter.SendFileAsync(chatId: ctx.Update.Chat.Id,
file: file,
caption: caption,
captionFormat: captionFormat,
inline: inline,
reply: reply,
ct: ct);
public static Task DeleteAsync(this PageContext ctx, string chatId, string messageId, CancellationToken ct = default)
=> ctx.Adapter.DeleteAsync(chatId, messageId, ct);
}

View File

@@ -4,6 +4,7 @@ namespace BotPages.Core.Messaging;
/// <summary>
/// Fluentбилдер для отправки сообщений (текст, кнопки, файлы, альбомы, прогресс).
/// Поддерживает указание адаптер-специфичных опций через `WithAdapterOption`.
/// </summary>
public sealed class MessageBuilder
{
@@ -15,11 +16,29 @@ public sealed class MessageBuilder
private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _files = new();
private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _album = new();
private bool _disableReplyKeyboard;
private string? _editMessageId = null;
private AdapterOptionsBag? _adapterOptions = null;
private string? _chatId = null;
/// <summary>Создать билдер сообщений.</summary>
public MessageBuilder(PageContext ctx) => _ctx = ctx;
/// <summary>
/// Установить опции для конкретного адаптера. Ключ адаптера определяется адаптером (напр., "telegram").
/// </summary>
public MessageBuilder WithAdapterOption<T>(string adapterType, T options)
{
if (_adapterOptions is null) _adapterOptions = new AdapterOptionsBag();
_adapterOptions.Set(adapterType, options);
return this;
}
/// <summary>ID чата куда отрпавить сообщение.</summary>
public MessageBuilder ChatId(string chatId)
{
_chatId = chatId;
return this;
}
/// <summary>Текст сообщения.</summary>
public MessageBuilder Text(string text, MessageFormat format = MessageFormat.Plain)
{
@@ -28,13 +47,6 @@ public sealed class MessageBuilder
return this;
}
/// <summary>Редактировать сообщение.</summary>
public MessageBuilder EditMessage(string messagId)
{
_editMessageId = messagId;
return this;
}
/// <summary>Добавить inlineкнопку.</summary>
public MessageBuilder Inline(string label, string value)
{
@@ -63,7 +75,7 @@ public sealed class MessageBuilder
return this;
}
/// <summary>Добавить строку inlineкнопок.</summary>
/// <summary>Добавить строки inlineкнопок.</summary>
public MessageBuilder Inline(IEnumerable<IEnumerable<InlineButton>> row)
{
_inline.AddRange(row.Select(t => t.ToList()).ToList());
@@ -73,7 +85,6 @@ public sealed class MessageBuilder
/// <summary>
/// Отключение Reply клавиатуры.
/// </summary>
/// <returns></returns>
public MessageBuilder DisableReply()
{
_disableReplyKeyboard = true;
@@ -96,7 +107,7 @@ public sealed class MessageBuilder
return this;
}
/// <summary>Добавить строку replyкнопок.</summary>
/// <summary>Добавить строки replyкнопок.</summary>
public MessageBuilder Reply(IEnumerable<IEnumerable<ReplyButton>> row)
{
_disableReplyKeyboard = false;
@@ -118,10 +129,20 @@ public sealed class MessageBuilder
return this;
}
/// <summary>Удалить сообщение.</summary>
public async Task DeleteAsync(string messageId, CancellationToken ct = default)
{
await _ctx.DeleteAsync(this._chatId ?? _ctx.Update.Chat.Id, messageId, ct);
}
/// <summary>Отправить собранное сообщение.</summary>
public async Task<string?> SendAsync(CancellationToken ct = default)
=> await SendAsync(string.Empty, ct);
/// <summary>Редактировать сообщение.</summary>
public async Task<string?> SendAsync(string messageId, CancellationToken ct = default)
{
string? messageId = null;
string? outMessageId = null;
List<List<ReplyButton>>? reply = null;
if (_disableReplyKeyboard) reply = new();
@@ -130,18 +151,38 @@ public sealed class MessageBuilder
// Текст
if (!string.IsNullOrWhiteSpace(_text))
{
messageId = await _ctx.SendTextAsync(_text, _format, _inline, reply, _editMessageId, ct);
var req = new SendRequest
{
ChatId = _chatId ?? _ctx.Update.Chat.Id,
Text = _text,
TextFormat = _format,
Inline = _inline,
Reply = reply,
MessageId = string.IsNullOrWhiteSpace(messageId) ? null : messageId,
AdapterOptions = _adapterOptions
};
outMessageId = await _ctx.SendAsync(req, ct);
}
// Файлы
foreach (var (file, caption, captionFormat) in _files)
await _ctx.SendFileAsync(file: file
, caption: caption
, captionFormat: captionFormat
, reply: reply
, inline: _inline
, ct: ct
);
{
var req = new SendRequest
{
ChatId = _chatId ?? _ctx.Update.Chat.Id,
File = file,
Caption = caption,
CaptionFormat = captionFormat,
Inline = _inline,
Reply = reply,
AdapterOptions = _adapterOptions
};
var res = await _ctx.SendAsync(req, ct);
// сохранить первый возвращённый id сообщения
if (outMessageId is null && res is not null) outMessageId = res;
}
// Альбом
if (_album.Count > 0)
@@ -156,7 +197,8 @@ public sealed class MessageBuilder
_files.Clear();
_album.Clear();
_editMessageId = null;
_adapterOptions = null;
_chatId = null;
return messageId;
}

View File

@@ -27,8 +27,12 @@ public sealed class ErrorHandlingMiddleware : IPageMiddleware
{
_logger.Log(LogLevel.Critical, "Unhandled exception in middleware pipeline.", ex);
// Теперь можно напрямую использовать PageContext для ответа
await ctx.SendTextAsync("Произошла ошибка при обработке запроса. Попробуйте ещё раз.", ct: ct);
// Отправляем универсальный запрос с текстом об ошибке
await ctx.SendAsync(new SendRequest
{
ChatId = ctx.Update.Chat.Id,
Text = "Произошла ошибка при обработке запроса. Попробуйте ещё раз."
}, ct);
}
}
}

View File

@@ -1,10 +1,4 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace BotPages.Core.Routing;
namespace BotPages.Core.Routing;
/// <summary>
/// Обработчик команды: получает контекст страницы, аргументы команды и токен отмены.

View File

@@ -15,8 +15,14 @@ public static class BotPagesAppExtension
/// <param name="messengerType"></param>
/// <returns></returns>
public static BotPagesApp AddTelegramAdapter(this BotPagesApp app, string token, string messengerType = "")
=> app.AddTelegramAdapter(token, null, messengerType);
/// <summary>
/// Добавление адаптера для телеграмм с опциями.
/// </summary>
public static BotPagesApp AddTelegramAdapter(this BotPagesApp app, string token, TelegramOptions? options, string messengerType = "")
{
var telegram = new TelegramAdapter(app.Logger, token);
var telegram = new TelegramAdapter(app.Logger, token, options);
if (!string.IsNullOrWhiteSpace(messengerType)) telegram.MessengerType = messengerType;

View File

@@ -0,0 +1,19 @@
using BotPages.Core.Messaging;
namespace BotPages.Telegram;
/// <summary>
/// Ðàñøèðåíèÿ äëÿ `MessageBuilder` ñïåöèôè÷íûå äëÿ Telegram.
/// Ïîçâîëÿþò óäîáíî çàäàòü `TelegramOptions` äëÿ êîíêðåòíîãî ñîîáùåíèÿ
/// áåç èçìåíåíèÿ ñàìîãî áèëäåðà.
/// </summary>
public static class MessageBuilderExtensions
{
/// <summary>
/// Óñòàíîâèòü îïöèè Telegram äëÿ êîíêðåòíîãî ñîîáùåíèÿ (ïåðåîïðåäåëÿþò îïöèè àäàïòåðà).
/// </summary>
public static MessageBuilder WithTelegramOptions(this MessageBuilder builder, TelegramOptions options)
{
return builder.WithAdapterOption(TelegramAdapter.AdapterType, options);
}
}

View File

@@ -10,7 +10,6 @@ using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Telegram.Bot;
using Telegram.Bot.Exceptions;
using Telegram.Bot.Types;
using Telegram.Bot.Types.Enums;
using Telegram.Bot.Types.ReplyMarkups;
@@ -22,11 +21,14 @@ namespace BotPages.Telegram;
/// Адаптер для Telegram на базе Telegram.Bot.
/// Реализует отправку текста, кнопок, файлов, альбомов и прогресса.
/// </summary>
public sealed class TelegramAdapter : IMessangerAdapterSetup
public sealed class TelegramAdapter : IMessengerAdapterSetup
{
internal static readonly string AdapterType = typeof(TelegramAdapter).FullName;
private readonly ILogger _logger;
private TelegramBotClient? _client;
private string _token;
private readonly TelegramOptions _options;
private static Capabilities _capabilities = new()
{
SupportsInlineButtons = true,
@@ -38,10 +40,11 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
};
/// <summary>Создать адаптер Telegram.</summary>
public TelegramAdapter(ILogger logger, string token)
public TelegramAdapter(ILogger logger, string token, TelegramOptions? options = null)
{
_logger = logger;
_token = token;
_options = options ?? new TelegramOptions();
}
/// <summary>
@@ -76,21 +79,13 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
errorHandler: async (_, ex, ct2) =>
{
_logger.Log(LogLevel.Warn, $"{MessengerType} error.", ex);
if (ex is ApiRequestException apiEx)
{
if (apiEx.ErrorCode == 409)
{
_logger.Log(LogLevel.Critical, $"{MessengerType} остановлен.");
await _.Close(ct2);
}
}
await Task.CompletedTask;
},
cancellationToken: ct
);
await _client.SetMyCommands(commands.Where(t => t.Publish).Select(t => new BotCommand(t.Name, t.Description ?? t.Name.TrimStart('/'))), cancellationToken: ct);
var me = await _client.GetMe();
@@ -99,13 +94,11 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
return;
}
/// <inheritdoc />
public async Task<string?> SendTextAsync(string chatId, string text,
MessageFormat format = MessageFormat.Plain,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
string? messageId = null,
CancellationToken ct = default)
/// <summary>
/// Универсальный внутренний метод отправки — определяет, нужно ли отправлять текст или файл по параметрам.
/// Возвращает id сообщения (или null).
/// </summary>
public async Task<string?> SendAsync(SendRequest req, CancellationToken ct)
{
if (_client is null)
{
@@ -113,206 +106,162 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
return null;
}
InlineKeyboardMarkup? inlineMarkup = null;
ReplyMarkup? markup = null;
if (inline is not null && inline.Any())
// Определите параметры адаптера (TelegramOptions) из папки или используйте параметры адаптера по умолчанию.
TelegramOptions telegramOptions = _options;
if (req.AdapterOptions is AdapterOptionsBag bag && bag.TryGet(AdapterType, out TelegramOptions? opt) && opt is not null)
{
inlineMarkup = new InlineKeyboardMarkup(
inline.Select(row => row.Select(b => new InlineKeyboardButton(b.Label, b.Value)).ToArray())
.ToArray()
telegramOptions = opt;
}
var disableNotification = !telegramOptions.NotifyOnSend;
// Build markup
var inlineMarkup = BuildInlineMarkup(req.Inline);
ReplyMarkup? markup = BuildReplyMarkup(req.Reply);
// Файлы: сейчас поддерживается один файл через SendRequest.File.
// При необходимости для нескольких файлов следует использовать альбомы (CreateAlbumBuilder)
if (req.File is not null)
{
if (inlineMarkup is not null) markup = inlineMarkup;
var sent = await SendFileAsync(req.File, req.ChatId, markup, disableNotification, req.Caption, req.CaptionFormat, ct);
return sent?.MessageId.ToString();
}
// Текст
if (!string.IsNullOrWhiteSpace(req.Text))
{
return await SendTextAsync(req, inlineMarkup, markup, disableNotification, ct);
}
return null;
}
/// <inheritdoc/>
public Task DeleteAsync(string chatId, string messageId, CancellationToken ct = default)
{
if (_client is null)
{
_logger.Log(LogLevel.Critical, $"{MessengerType} client is not initialized.");
return null;
}
return _client.DeleteMessage(chatId, Convert.ToInt32(messageId), ct);
}
// --- Helpers ---
private InlineKeyboardMarkup? BuildInlineMarkup(IEnumerable<IEnumerable<InlineButton>>? inline)
{
if (inline is null || !inline.Any()) return null;
return new InlineKeyboardMarkup(
inline.Select(row => row.Select(b => new InlineKeyboardButton(b.Label, b.Value)).ToArray()).ToArray()
);
}
else if (reply is not null)
private ReplyMarkup? BuildReplyMarkup(IEnumerable<IEnumerable<ReplyButton>>? reply)
{
if (reply is null) return null;
if (reply.Any())
{
markup = new ReplyKeyboardMarkup(
reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray()
)
return new ReplyKeyboardMarkup(reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray())
{
ResizeKeyboard = true
};
}
else
{
markup = new ReplyKeyboardRemove();
return new ReplyKeyboardRemove();
}
}
var parseMode = ParseMode.None;
private static ParseMode GetParseMode(MessageFormat? format)
{
return format switch
{
MessageFormat.Html => ParseMode.Html,
MessageFormat.Markdown => ParseMode.MarkdownV2,
_ => ParseMode.None,
};
}
switch (format)
private async Task<InputFile> CreateInputFileAsync(FileDescriptor file, CancellationToken ct)
{
case MessageFormat.Html:
Stream? stream = null;
if (file.GetStreamAsync is not null)
{
parseMode = ParseMode.Html;
break;
stream = await file.GetStreamAsync(ct);
if (stream is not null) stream.Position = 0;
}
case MessageFormat.Plain:
if (stream is not null && stream != Stream.Null)
{
parseMode = ParseMode.None;
break;
return new InputFileStream(stream, file.Name);
}
case MessageFormat.Markdown:
else if (file.Id.StartsWith("http://") || file.Id.StartsWith("https://"))
{
parseMode = ParseMode.MarkdownV2;
break;
return new InputFileUrl(file.Id);
}
default:
else
{
_logger.Log(LogLevel.Warn, $"MessageFormat '{format}' not supported. Degraded to plain text.");
break;
return new InputFileId(file.Id);
}
}
// Длина сообщения
private async Task<Message?> SendFileAsync(FileDescriptor file, string chatId, ReplyMarkup? markup, bool disableNotification, string? caption, MessageFormat? captionFormat, CancellationToken ct)
{
var inputFile = await CreateInputFileAsync(file, ct);
var parseMode = GetParseMode(captionFormat);
return file.Kind switch
{
FileKind.Photo => await _client.SendPhoto(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, disableNotification: disableNotification, cancellationToken: ct),
FileKind.Video => await _client.SendVideo(long.Parse(chatId), inputFile, caption: caption ?? "", parseMode, replyMarkup: markup, disableNotification: disableNotification, cancellationToken: ct),
FileKind.Audio => await _client.SendAudio(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, disableNotification: disableNotification, cancellationToken: ct),
_ => await _client.SendDocument(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, disableNotification: disableNotification, cancellationToken: ct),
};
}
private async Task<string?> SendTextAsync(SendRequest req, InlineKeyboardMarkup? inlineMarkup, ReplyMarkup? markup, bool disableNotification, CancellationToken ct)
{
var format = req.TextFormat ?? MessageFormat.Plain;
var parseMode = GetParseMode(format);
var text = req.Text!;
if (text.Length > Capabilities.MaxMessageLength)
{
_logger.Log(LogLevel.Warn, $"Message too long ({text.Length}). Truncated to {Capabilities.MaxMessageLength}.");
text = text.Substring(0, Capabilities.MaxMessageLength);
}
if (!string.IsNullOrWhiteSpace(messageId))
if (!string.IsNullOrWhiteSpace(req.MessageId))
{
await _client.EditMessageText(
messageId: int.Parse(messageId),
chatId: long.Parse(chatId),
messageId: int.Parse(req.MessageId),
chatId: long.Parse(req.ChatId),
text: text,
parseMode: parseMode,
replyMarkup: inlineMarkup,
cancellationToken: ct
);
return messageId;
return req.MessageId;
}
else
{
if (inlineMarkup is not null) markup = inlineMarkup;
var message = await _client.SendMessage(
chatId: long.Parse(chatId),
chatId: long.Parse(req.ChatId),
text: text,
parseMode: parseMode,
replyMarkup: markup,
disableNotification: disableNotification,
cancellationToken: ct
);
return message.Id.ToString();
}
}
/// <inheritdoc />
public async Task SendFileAsync(string chatId,
FileDescriptor file,
string? caption = null,
MessageFormat? captionFormat = null,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
CancellationToken ct = default
)
{
if (_client is null)
{
_logger.Log(LogLevel.Critical, $"{MessengerType} client is not initialized.");
return;
}
// Получаем поток, если он задан
Stream? stream = null;
if (file.GetStreamAsync is not null)
{
stream = await file.GetStreamAsync(ct);
stream.Position = 0;
}
InputFile inputFile;
if (stream is not null && stream != Stream.Null)
{
inputFile = new InputFileStream(stream, file.Name);
}
else if (file.Id.StartsWith("http://") || file.Id.StartsWith("https://"))
{
inputFile = new InputFileUrl(file.Id);
}
else
{
inputFile = new InputFileId(file.Id);
}
var parseMode = ParseMode.None;
switch (captionFormat)
{
case MessageFormat.Html:
{
parseMode = ParseMode.Html;
break;
}
case MessageFormat.Plain:
{
parseMode = ParseMode.None;
break;
}
case MessageFormat.Markdown:
{
parseMode = ParseMode.MarkdownV2;
break;
}
case null:
{
parseMode = ParseMode.None;
break;
}
default:
{
_logger.Log(LogLevel.Warn, $"MessageFormat '{captionFormat}' not supported. Degraded to plain text.");
break;
}
}
ReplyMarkup? markup = null;
if (inline is not null && inline.Any())
{
markup = new InlineKeyboardMarkup(
inline.Select(row => row.Select(b => new InlineKeyboardButton(b.Label, b.Value)).ToArray())
.ToArray()
);
}
else if (reply is not null)
{
if (reply.Any())
{
markup = new ReplyKeyboardMarkup(
reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray()
)
{
ResizeKeyboard = true
};
}
else
{
markup = new ReplyKeyboardRemove();
}
}
// В зависимости от FileKind выбираем подходящий метод
switch (file.Kind)
{
case FileKind.Photo:
await _client.SendPhoto(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break;
case FileKind.Video:
await _client.SendVideo(long.Parse(chatId), inputFile, caption: caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break;
case FileKind.Audio:
await _client.SendAudio(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break;
default:
await _client.SendDocument(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break;
return message.MessageId.ToString();
}
}

View File

@@ -53,7 +53,17 @@ public sealed class TelegramAlbumBuilder : IAlbumBuilder
{
_logger.Log(LogLevel.Warn, "Albums not supported. Degraded to sequential sends.");
foreach (var (file, caption, captionFormat) in _items)
await _adapter.SendFileAsync(_ctx.Update.Chat.Id, file, caption, captionFormat, ct: ct);
{
var req = new SendRequest
{
ChatId = _ctx.Update.Chat.Id,
File = file,
Caption = caption,
CaptionFormat = captionFormat
};
await _ctx.SendAsync(req, ct);
}
return;
}
@@ -95,7 +105,16 @@ public sealed class TelegramAlbumBuilder : IAlbumBuilder
{
// Telegram не поддерживает document в альбомах — деградация
_logger.Log(LogLevel.Warn, $"Document '{file.Kind}' in album not supported. Sending document separately.");
await _adapter.SendFileAsync(_ctx.Update.Chat.Id, file, caption, captionFormat, ct: ct);
var req = new SendRequest
{
ChatId = _ctx.Update.Chat.Id,
File = file,
Caption = caption,
CaptionFormat = captionFormat
};
await _ctx.SendAsync(req, ct);
}
}

View File

@@ -0,0 +1,14 @@
namespace BotPages.Telegram;
/// <summary>
/// Настройки адаптера Telegram, применяемые по умолчанию при отправке сообщений.
/// </summary>
public sealed class TelegramOptions
{
/// <summary>
/// Отправлять ли уведомление (sound) при отправке сообщения. По умолчанию true.
/// </summary>
public bool NotifyOnSend { get; set; } = true;
// В будущем можно добавить: default parse mode, disable web page preview и т.д.
}

View File

@@ -6,7 +6,6 @@ namespace Demo.Pages;
/// <summary>
/// Страница ввода деталей заявки.
/// Страница с параметрами и получением состояния.
/// </summary>
public sealed class DetailsPage : StatefullPage<string>
{
@@ -32,20 +31,15 @@ public sealed class DetailsPage : StatefullPage<string>
switch (payload)
{
case "next":
{
await SaveState(ctx, ct);
await ctx.Navigation.GoToAsync<FilesPage>(ctx, ct);
break;
}
case "back":
{
await ctx.Navigation.GoToAsync<TitlePage>(ctx, ct);
break;
}
}
;
}
public override async Task OnText(PageContext ctx, string text, CancellationToken ct)
{
@@ -61,7 +55,6 @@ public sealed class DetailsPage : StatefullPage<string>
string? title = "";
args?.TryGetValue("title", out title);
// Навигация на страницу по имени
await ctx.Navigation.GoToAsync<DetailsPage, string>(ctx, title ?? "", ct);
};
}

View File

@@ -8,14 +8,14 @@ namespace Demo.Pages;
[Route("FileSend")]
public sealed class FileSendPage : SingletonPage
{
public override Task OnEnter(PageContext ctx, CancellationToken ct)
public override async Task OnEnter(PageContext ctx, CancellationToken ct)
{
var content = "Hello from BotPages! This file is generated on the fly.";
var stream = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(content));
var demoFile = new FileDescriptor
{
Id = "", // не используется при отправке нового файла
Id = "",
Name = "demo.txt",
Extension = "txt",
Size = stream.Length,
@@ -23,9 +23,11 @@ public sealed class FileSendPage : SingletonPage
GetStreamAsync = _ => Task.FromResult<Stream>(stream)
};
return new MessageBuilder(ctx)
await new MessageBuilder(ctx)
.Text("Вот пример отправки нового файла 📎", MessageFormat.Markdown)
.File(demoFile, "Демонстрационный файл")
.SendAsync(ct);
await ctx.GoToHomeAsync(ct);
}
}

View File

@@ -6,7 +6,7 @@ namespace Demo.Pages;
/// <summary>
/// Страница загрузки файлов.
/// Обычная страница с полученим и сохранением состояния.
/// Обычная страница с получением и сохранением состояния.
/// </summary>
public sealed class FilesPage : SingletonPage
{
@@ -18,15 +18,17 @@ public sealed class FilesPage : SingletonPage
public override async Task OnFile(PageContext ctx, List<FileDescriptor> files, CancellationToken ct)
{
// Пересылаем каждый файл обратно с подтверждением
foreach (var file in files)
{
await ctx.SendFileAsync(file, $"Файл '{file.Name}' получен и отправлен обратно.", ct: ct);
await new MessageBuilder(ctx)
.File(file, $"Файл '{file.Name}' получен и отправлен обратно.")
.SendAsync(ct);
}
//Обращение через Storage
// Сохраняем данные в хранилище состояния
var request = await ctx.StateStorage.GetAsync<Models.Request>(ctx.SessionKey, "Request", ct);
request.FilesCount = files.Count;
//Обращение через Context
await ctx.SetStorageAsync("Request", request, ct);
await new MessageBuilder(ctx)

View File

@@ -10,9 +10,7 @@ public sealed class SubmitPage : SingletonPage
{
public override async Task OnEnter(PageContext ctx, CancellationToken ct)
{
var progress = new MessageBuilder(ctx);
var messageId = await progress
var messageId = await new MessageBuilder(ctx)
.Text("Отправка заявки\n7%")
.SendAsync(ct);
@@ -21,10 +19,9 @@ public sealed class SubmitPage : SingletonPage
{
i += 25;
Thread.Sleep(TimeSpan.FromMilliseconds(200));
await progress
await new MessageBuilder(ctx)
.Text($"Отправка заявки\n{i}%")
.EditMessage(messageId!)
.SendAsync(ct);
.SendAsync(messageId, ct);
}
while (i < 100);

View File

@@ -1,12 +1,10 @@
using BotPages.Core;
using BotPages.Core.Abstractions;
using BotPages.Core.Messaging;
using BotPages.Core.Routing;
namespace Demo.Pages;
/// <summary>
/// Страница ввода заголовка заявки.
/// Обычная страница вводом текста.
/// </summary>
public sealed class TitlePage : SingletonPage
{

View File

@@ -7,7 +7,6 @@ namespace Demo.Pages;
/// <summary>
/// Стартовая страница демо‑бота.
/// Обычная страница с кнопками
/// </summary>
[Route("Welcome")]
public sealed class WelcomePage : SingletonPage
@@ -31,20 +30,14 @@ public sealed class WelcomePage : SingletonPage
switch (button)
{
case WelcomePageButtons.CreateRequest:
{
return ctx.Navigation.GoToAsync<TitlePage>(ctx, ct);
}
case WelcomePageButtons.Help:
{
return new MessageBuilder(ctx).Text("Здесь будет справка.", MessageFormat.Plain).SendAsync(ct);
}
case WelcomePageButtons.SendFile:
{
return ctx.Navigation.GoToAsync<FileSendPage>(ctx, ct);
}
}
return base.OnText(ctx, text, ct);
}

View File

@@ -26,7 +26,13 @@ namespace Demo
{
if (args is null || !args.TryGetValue("page", out var pageName))
{
await ctx.SendTextAsync("Не указана страница для открытия.", ct: ct);
var req = new BotPages.Core.Abstractions.SendRequest
{
ChatId = ctx.Update.Chat.Id,
Text = "Не указана страница для открытия."
};
await ctx.SendAsync(req, ct: ct);
return;
}
@@ -37,7 +43,7 @@ namespace Demo
var app = new BotPagesApp(state, logger)
.AddDefaultPage<WelcomePage>()
.MapCommand<WelcomePage>("/start", true, "Главная")
.MapCommand("/open {page}", openHandler, true, "открыть станицу /open {page}")
.MapCommand("/open {page}", openHandler, true, "открыть страницу /open {page}")
.MapCommand(DetailsPage.Command, DetailsPage.CommandHandler, true, DetailsPage.CommandDescription)
.AutoMapRoute()
.AddMiddleware(new ErrorHandlingMiddleware(logger))

142
README.md
View File

@@ -1,92 +1,82 @@
# BotPages Framework
# BotPages
BotPages — это архитектурный фреймворк для построения Telegram/MAXботов с чистыми слоями, расширяемыми API и удобным developer experience.
BotPages — кроссплатформенный фреймворк для создания диалоговых ботов с моделью страниц (pagebased conversational framework).
## ✨ Возможности
- **Навигация через страницы**: каждая страница — отдельный обработчик логики.
- **Единый метод GoToAsync**: автоматически поддерживает как `SingletonPage`, так и `StatefulPage`.
- **StatefulPage**: свойства автоматически сохраняются в `StateStorage`.
- **SingletonPage**: один экземпляр на всё приложение, без состояния.
- **Middleware**: подключение промежуточных обработчиков (логирование, обработка ошибок).
- **Автоматическая регистрация страниц**: через рефлексию.
- **Роутинг страниц**: возможность устанавливать пути вызова для страниц.
- **Команды**: возможность установки команд, которые работают приоритетнее обработчиков страниц.
- **Минимум boilerplate**: декларативные интерфейсы и fluent API.
Цели проекта:
- Простая модель страниц и навигации.
- Портируемость между мессенджерами через адаптеры.
- Поддержка middleware и декларативной системы команд.
- Минимум boilerplate и удобный developer experience.
## 🚀 Быстрый старт
```csharp
var app = new BotPagesApp(factory, state, logger)
.UseDefaultPage<WelcomePage>()
.MapCommand<WelcomePage>("/start")
.AddMiddleware(new LoggingMiddleware(logger))
.AddMiddleware(new ErrorHandlingMiddleware(logger));
Структура репозитория
- `BotPages.Core` — ядро фреймворка: навигация, страницы, маршрутизация, реестр команд, middleware, абстракции адаптеров и хранилища состояния.
- `BotPages.Telegram` — адаптер для Telegram Bot API (реализация `IMessengerAdapter`).
- `Demo` — пример приложения с несколькими страницами и конфигурацией адаптера.
- `BotPages` — мета‑проект для упаковки библиотек.
- `docs/` — внутренняя документация проекта (Quickstart, API reference и т.д.).
Требования
- .NET 8 SDK
- C# 12
Быстрый старт (локально)
1. Клонируйте репозиторий:
```bash
git clone https://git.frigat.duckdns.org/FrigaT/BotPages.git
cd BotPages
```
## 📄 Пример страниц
2. Соберите решения:
### StatefulPage
```csharp
public sealed class WelcomePage : StatefulPage
{
[Statefull("visitCount")]
private int VisitCount;
private PageContext? Context { get; set; }
public override async Task OnEnter(PageContext ctx, CancellationToken ct)
{
Context = ctx;
LoadState();
VisitCount++;
SaveState();
await ctx.SendTextAsync($"Добро пожаловать 🚀. Вы заходили сюда {VisitCount} раз(а).", ct: ct);
}
}
```bash
dotnet build
```
### SingletonPage
```csharp
public sealed class HelpPage : SingletonPage
{
public override Task OnEnter(PageContext ctx, CancellationToken ct)
=> ctx.SendTextAsync("Это справка 📖", ct: ct);
}
3. Запуск демо (Telegram):
- Установите переменную окружения `TELEGRAM_TOKEN` с токеном бота.
```bash
setx TELEGRAM_TOKEN "<token>" # Windows
export TELEGRAM_TOKEN="<token>" # Linux/macOS
```
## 🧩 Навигация
```csharp
await ctx.Navigation.GoToAsync<WelcomePage>(ctx, ct); // Stateful
await ctx.Navigation.GoToAsync<WelcomePage>(ctx, agrs, ct); // Stateful with arguments
await ctx.Navigation.GoToAsync<HelpPage>(ctx, ct); // Singleton
await ctx.Navigation.GoToHome(ctx, ct); // Stateful
- Запустите demo:
```bash
dotnet run --project Demo
```
## ⚙️ Middleware
```csharp
public sealed class LoggingMiddleware : IPageMiddleware
{
private readonly ILogger _logger;
public LoggingMiddleware(ILogger logger) => _logger = logger;
Простой пример конфигурации
public async Task InvokeAsync(PageContext ctx, Func<Task> next, CancellationToken ct)
{
_logger.Log(LogLevel.Info, $"Update: {ctx.Update.Kind}");
await next();
}
}
```csharp
var app = new BotPagesApp(stateStorage, logger)
.AddTelegramAdapter(token)
.AddDefaultPage<WelcomePage>()
.MapCommand<WelcomePage>('/start')
.AddMiddleware(new LoggingMiddleware(logger));
await app.Build(CancellationToken.None);
```
## 🏗 Архитектурные принципы
- **Separation of concerns**: страницы не знают о транспорте, всё через адаптеры.
- **Расширяемость**: новые страницы и middleware подключаются декларативно.
- **Прозрачность**: минимум скрытой логики, всё явно через контекст.
- **Developer Experience**: удобные API, автоматическая регистрация, документация через `///summary`.
Ключевые концепции
## 📌 Итог
BotPages позволяет писать чистые, расширяемые и удобные для команды боты:
- минимум boilerplate,
- декларативные интерфейсы,
- прозрачная навигация,
- автоматическое управление состоянием.
- `SendRequest` — единый формат запроса на отправку (текст, файлы, кнопки, опции). Адаптеры реализуют `IMessengerAdapter.SendAsync(SendRequest)`.
- `Page`, `StatefulPage`, `SingletonPage` — модели страниц с жизненным циклом (`OnEnter`, `OnUpdate`, `OnText`, `OnButton`, `OnFile`, `OnError`).
- `NavigationService` — управление переходами между страницами.
- `IPageMiddleware` — middleware-конвейер, выполняющийся для каждого апдейта.
Документация
Полная внутренняя документация находится в `docs/`:
- `docs/GETTING_STARTED.md` — быстрый старт и примеры конфигурации.
- `docs/API_REFERENCE.md` — краткий reference публичных API.
- `docs/PROJECT_DOCUMENTATION.md` — обзор архитектуры и компонентов.
Лицензия
Проект распространяется под лицензией MIT. Смотрите файл `LICENSE`.

30
docfx.json Normal file
View File

@@ -0,0 +1,30 @@
{
"metadata": [
{
"src": [
{ "files": ["BotPages.Core/BotPages.Core.csproj"] },
{ "files": ["BotPages.Telegram/BotPages.Telegram.csproj"] },
{ "files": ["BotPages/BotPages.csproj"] }
],
"dest": "api",
"properties": {
"TargetFramework": "net8.0"
}
}
],
"build": {
"content": [
{ "files": ["docs/**.md"] },
{ "files": ["README.md"] },
{ "files": ["api/**.yml"], "dest": "api" }
],
"resource": [
{ "files": ["docs/**.png", "docs/**.jpg", "docs/**.svg"] }
],
"dest": "_site",
"globalMetadata": {
"_enableSearch": true
},
"template": [ "default" ]
}
}

46
docs/API_REFERENCE.md Normal file
View File

@@ -0,0 +1,46 @@
# Справочник API
Ниже краткое описание публичных API проекта BotPages.
## BotPages.Core
### `BotPagesApp`
- `AddTelegramAdapter(string token)` — регистрирует Telegram адаптер с заданным токеном.
- `AddAdapter(string messengerType, IMessengerAdapter adapter)` — регистрирует произвольный адаптер.
- `AddMiddleware(IPageMiddleware middleware)` — добавляет middleware в pipeline.
- `MapCommand<TPage>(string template)` — привязать команду к странице.
- `MapRoute<TPage>(string template)` — зарегистрировать маршрут.
- `AutoMapRoute()` — выполнить автопоиск Page?классов и зарегистрировать их маршруты.
- `Build(CancellationToken ct)` — подготовить и запустить приложение.
### `IMessengerAdapter`
- `Task<string?> SendAsync(SendRequest request, CancellationToken ct = default)` — универсальный метод отправки для всех адаптеров.
- `IAlbumBuilder CreateAlbumBuilder(PageContext ctx)` — создать билдер альбома (если поддерживается).
- `Task OnLeaveAsync(PageContext ctx, CancellationToken ct)` — вызывается при уходе со страницы.
### `SendRequest`
- `ChatId` — идентификатор чата.
- `Text`, `TextFormat` — текст и формат.
- `File`, `Caption`, `CaptionFormat` — файл и подпись.
- `Inline`, `Reply` — inline и reply клавиатуры.
- `MessageId` — id редактируемого сообщения.
- `AdapterOptions` — адаптер?специфичные опции (например `TelegramOptions`).
### `PageContext` расширения
- `SendAsync(SendRequest request, CancellationToken ct = default)` — отправить `SendRequest`.
- `SendTextAsync(...)`, `SendFileAsync(...)` — удобные оболочки, создающие `SendRequest`.
## BotPages.Telegram
- `TelegramAdapter` — реализация `IMessengerAdapter` для Telegram.
- `TelegramOptions` — настройки адаптера (например `NotifyOnSend`).
- `MessageBuilderExtensions.WithTelegramOptions` — расширение для установки `TelegramOptions` для конкретного сообщения.
# Генерация документации
Рекомендуется использовать `docfx` или `Doxygen` для генерации HTML-документации из XML-файлов, которые генерируются при сборке (см. `GenerateDocumentationFile` в `.csproj`).
# Примечания
Этот документ — краткое описание API. Для полного списка публичных типов и методов можно сгенерировать reference из XML-вывода компиляции.

19
docs/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,19 @@
# Contributing to BotPages
Спасибо за интерес к проекту! Пожалуйста, перед отправкой PR убедитесь, что:
- Ваш код проходит сборку: `dotnet build`.
- Добавлены/обновлены тесты, если уместно.
- Следуется стиль кода проекта и включены nullable-аннотации.
Документация генерируется через `docfx`. См. `docfx.json` в корне репозитория и скрипты в `scripts/`.
Пример локальной генерации документации:
```bash
# Unix
./scripts/generate-docs.sh
# Windows PowerShell
./scripts/generate-docs.ps1
```

47
docs/GETTING_STARTED.md Normal file
View File

@@ -0,0 +1,47 @@
# Быстрый старт с BotPages
Это руководство поможет быстро запустить demo?приложение с Telegram?адаптером.
Требования
- .NET 8 SDK
- Токен Telegram?бота (для demo)
Сборка
```bash
dotnet build
```
Запуск demo
1. Установите переменную окружения `TELEGRAM_TOKEN`:
```bash
setx TELEGRAM_TOKEN "<token>" # Windows
export TELEGRAM_TOKEN="<token>" # Linux/macOS
```
2. Запустите demo:
```bash
dotnet run --project Demo
```
Пример конфигурации приложения
```csharp
var app = new BotPagesApp(stateStorage, logger)
.AddTelegramAdapter(token)
.AddDefaultPage<WelcomePage>()
.MapCommand<WelcomePage>("/start")
.AddMiddleware(new LoggingMiddleware(logger));
await app.Build(CancellationToken.None);
```
Основные понятия
- `SendRequest` — единый формат запроса на отправку (текст, файлы, кнопки, адаптер?опции). Используйте `PageContext.SendAsync` для отправки.
- `Page` / `StatefulPage` / `SingletonPage` — модели страниц и их жизненный цикл.
- `IPageMiddleware` — middleware выполняется для каждого входящего обновления.
Далее: см. `docs/API_REFERENCE.md` для описания публичных API.

View File

@@ -0,0 +1,114 @@
# Документация проекта BotPages
Краткая документация по всему проекту. Описывает архитектуру, основные компоненты, сценарии использования и сборки.
## Структура репозитория
- `BotPages.Core` — ядро фреймворка.
- Навигация: `NavigationService`, страницы: `Page`, `StatefulPage`, `SingletonPage`.
- Маршрутизация: `RoutesRegistry` (авторегистрация через `AutoMapRoute`).
- Команды: `CommandsRegistry` (парсер шаблонов команд, `TryDispatch`).
- Middleware: интерфейс `IPageMiddleware` и реализация `LoggingMiddleware`.
- Абстракции адаптеров/адаптер-фабрика: `IMessangerAdapterSetup`, `IMessengerAdapterFactory` (например `MultiAdapterFactory`).
- Хранилище состояния: `IStateStorage`.
- `BotPages.Telegram` — реализация адаптера для Telegram (использует `Telegram.Bot`).
- `Demo` — демонстрационное приложение с примерами страниц и конфигурации.
- `BotPages` — мета-проект/пакет для упаковки.
## Главные сущности и сценарии использования
- `BotPagesApp` — точка конфигурации и запуска приложения.
- Регистрация адаптеров: `AddAdapter(string messengerType, IMessangerAdapterSetup adapter)`.
- Регистрация middleware: `AddMiddleware<T>(T instance)`.
- Регистрация команд: `MapCommand<TPage>(string template)` или `MapCommand(string template, CommandHandler handler)`.
- Маршруты: `MapRoute<TPage>(string template)` и `AutoMapRoute()` для автоматического поиска страниц по рефлексии.
- Запуск: `Build(CancellationToken)` — старт адаптеров и приём апдейтов.
- Страницы:
- `Page` — базовый класс (абстрактный) с жизненным циклом (`OnEnter`, `OnUpdate`, `OnText`, `OnButton`, `OnFile`, `OnError`).
- `StatefulPage` — хранит состояние в `IStateStorage` (сериализация полей, атрибуты для stateful-полей).
- `SingletonPage` — один экземпляр на приложение, без per-session состояния.
- Навигация: `NavigationService` управляет текущей страницей пользователя (определяется по `PageContext.SessionKey`) и предоставляет методы `GoToAsync<TPage>`, `GoToHomeAsync`.
- Команды: шаблоны вида `/cmd {arg} {opt?}`. Парсер в `CommandsRegistry.ToRegex` поддерживает именованные группы и опциональные аргументы. При совпадении вызывается `CommandHandler(PageContext, IDictionary<string,string>, CancellationToken)`.
- Middleware: реализуют `IPageMiddleware.InvokeAsync(PageContext, Func<Task> next, CancellationToken ct)`; вызываются в порядке регистрации (конвейер).
## Формат и схема апдейта
- `UpdateContext` содержит данные апдейта: `MessengerType`, `Chat`, `User`, `Kind` (флаги `Text`, `Button`, `File`), `Text`, `Files`.
- При поступлении апдейта `BotPagesApp.HandleUpdateAsync` создаёт `PageContext` и:
1. Проверяет команды (если текст и начинается с `/`) — команды имеют приоритет.
2. Запускает pipeline middleware.
3. Передаёт управление текущей странице через `DispatchToPageAsync`.
## Расширение и адаптеры
- Чтобы добавить новый мессенджер, реализуйте `IMessangerAdapterSetup`/`IMessengerAdapter` и зарегистрируйте через `BotPagesApp.AddAdapter`.
- `MultiAdapterFactory` служит для хранения и разрешения адаптеров по ключу `messengerType`.
## Сборка и запуск
Требования:
- .NET 8 SDK
Сборка проекта:
```bash
dotnet build
```
Запуск демонстрации:
```bash
dotnet run --project Demo
```
Для Telegram-адаптера настройте токен и параметры в `Demo` (или в коде инициализации адаптера).
## Документы API и комментарии
XML-документация генерируется флагом `GenerateDocumentationFile` в `.csproj` для проектов. Для автогенерации документации используйте стандартные инструменты (например, `docfx`, `doxygen` или `MkDocs` с генерацией из XML).
## Примеры
- Пример регистрации кусочка конфигурации:
```csharp
var app = new BotPagesApp(stateStorage, logger)
.AddAdapter("telegram", new TelegramAdapterSetup(token))
.AddMiddleware(new LoggingMiddleware(logger))
.MapCommand<WelcomePage>("/start")
.AddDefaultPage<WelcomePage>();
await app.Build(CancellationToken.None);
```
- Пример простой страницы:
```csharp
public sealed class WelcomePage : StatefulPage
{
public override async Task OnEnter(PageContext ctx, CancellationToken ct)
{
await ctx.SendTextAsync("Добро пожаловать", ct: ct);
}
}
```
## Вклад и тестирование
- Направляйте PR в репозиторий. Описывайте изменения в заголовке и теле PR.
- Поддерживайте единый стиль кода и null-safe практики (`Nullable` включён).
## Лицензия
Проект распространяется под лицензией MIT (см. `.csproj` и `LICENSE`).
---
Это краткий обзор. При необходимости можно сгенерировать подробный Reference по API (список публичных типов и методов) в отдельный документ.

View File

@@ -0,0 +1,2 @@
/* Minimal styling overrides for docfx output */
body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", "Liberation Sans", sans-serif; }

View File

@@ -0,0 +1,7 @@
module.exports = {
"templates": {
"global": {
"favicon": "favicon.ico"
}
}
};

22
scripts/generate-docs.ps1 Normal file
View File

@@ -0,0 +1,22 @@
Param(
[string]$DocfxPath = "docfx",
[string]$WorkingDir = "$(Resolve-Path .)"
)
$ErrorActionPreference = 'Stop'
Write-Host "Generating docfx documentation..."
if (-not (Get-Command $DocfxPath -ErrorAction SilentlyContinue)) {
Write-Host "Docfx not found on PATH. Install docfx or provide full path to docfx.exe" -ForegroundColor Yellow
}
Push-Location $WorkingDir
try {
& $DocfxPath metadata docfx.json
& $DocfxPath build docfx.json
Write-Host "Docfx build complete. Output in _site folder" -ForegroundColor Green
}
finally {
Pop-Location
}

14
scripts/generate-docs.sh Normal file
View File

@@ -0,0 +1,14 @@
#!/usr/bin/env bash
DOCFX_PATH=${DOCFX_PATH:-docfx}
WORKING_DIR=$(pwd)
if ! command -v "$DOCFX_PATH" >/dev/null 2>&1; then
echo "docfx not found. Install it or set DOCFX_PATH to the executable path."
fi
pushd "$WORKING_DIR" > /dev/null
$DOCFX_PATH metadata docfx.json
$DOCFX_PATH build docfx.json
popd > /dev/null
echo "Docfx build complete. Output in _site folder"