Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0ed47b2b90 | |||
|
|
f29e72a6f2 | ||
|
|
0089926fb0 | ||
|
|
4124e8c554 | ||
|
|
37cb6599ba | ||
|
|
833d8c80d9 | ||
|
|
41986987b1 | ||
| 246a5cb278 | |||
| 644749929e | |||
| 8528b814d8 |
44
BotPages.Core/Abstractions/AdapterOptionsBag.cs
Normal file
44
BotPages.Core/Abstractions/AdapterOptionsBag.cs
Normal 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
using BotPages.Core.Context;
|
using BotPages.Core.Context;
|
||||||
using BotPages.Core.Messaging;
|
|
||||||
|
|
||||||
namespace BotPages.Core.Abstractions;
|
namespace BotPages.Core.Abstractions;
|
||||||
|
|
||||||
@@ -15,27 +14,14 @@ public interface IMessengerAdapter
|
|||||||
Capabilities Capabilities { get; }
|
Capabilities Capabilities { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Отправить текстовое сообщение в чат.
|
/// Универсальный метод отправки с использованием общего описания запроса.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Task<string?> SendTextAsync(string chatId,
|
Task<string?> SendAsync(SendRequest request, CancellationToken ct = default);
|
||||||
string text,
|
|
||||||
MessageFormat format = MessageFormat.Plain,
|
|
||||||
IEnumerable<IEnumerable<InlineButton>>? inline = null,
|
|
||||||
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
|
|
||||||
string? messageId = null,
|
|
||||||
CancellationToken ct = default
|
|
||||||
);
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Отправить файл в чат.
|
/// Универсальный метод удаления сообщения.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Task SendFileAsync(string chatId,
|
Task DeleteAsync(string chatId, string messageId, CancellationToken ct = default);
|
||||||
FileDescriptor file,
|
|
||||||
string? caption = null,
|
|
||||||
MessageFormat? captionFormat = null,
|
|
||||||
IEnumerable<IEnumerable<InlineButton>>? inline = null,
|
|
||||||
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
|
|
||||||
CancellationToken ct = default);
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Создать билдер альбома для отправки медиагруппы.
|
/// Создать билдер альбома для отправки медиагруппы.
|
||||||
@@ -51,7 +37,7 @@ public interface IMessengerAdapter
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Контракт конфигурации адаптера.
|
/// Контракт конфигурации адаптера.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public interface IMessangerAdapterSetup : IMessengerAdapter
|
public interface IMessengerAdapterSetup : IMessengerAdapter
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Запуск работы адаптера
|
/// Запуск работы адаптера
|
||||||
|
|||||||
@@ -4,14 +4,14 @@ namespace BotPages.Core.Abstractions;
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Фабрика адаптеров мессенджеров.
|
/// Фабрика адаптеров мессенджеров.
|
||||||
/// Используется для разрешения конкретного <see cref="IMessangerAdapterSetup"/> по типу мессенджера.
|
/// Используется для разрешения конкретного <see cref="IMessengerAdapterSetup"/> по типу мессенджера.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public interface IMessengerAdapterFactory
|
public interface IMessengerAdapterFactory
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Список зарегистрированных адаптеров.
|
/// Список зарегистрированных адаптеров.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Dictionary<string, IMessangerAdapterSetup> Adapters { get; }
|
Dictionary<string, IMessengerAdapterSetup> Adapters { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Зарегистрировать адаптер для указанного типа мессенджера.
|
/// Зарегистрировать адаптер для указанного типа мессенджера.
|
||||||
@@ -23,9 +23,9 @@ public interface IMessengerAdapterFactory
|
|||||||
/// Экземпляр адаптера, реализующий <see cref="IMessengerAdapter"/>.
|
/// Экземпляр адаптера, реализующий <see cref="IMessengerAdapter"/>.
|
||||||
/// </param>
|
/// </param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
/// Текущий экземпляр <see cref="MultiAdapterFactory"/> для цепочки вызовов.
|
/// Текущий экземпляр <see cref="IMessengerAdapterFactory"/> для цепочки вызовов.
|
||||||
/// </returns>
|
/// </returns>
|
||||||
IMessengerAdapterFactory Register(string messengerType, IMessangerAdapterSetup adapter);
|
IMessengerAdapterFactory Register(string messengerType, IMessengerAdapterSetup adapter);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Получить адаптер для указанного мессенджера.
|
/// Получить адаптер для указанного мессенджера.
|
||||||
|
|||||||
@@ -6,12 +6,12 @@
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class MultiAdapterFactory : IMessengerAdapterFactory
|
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>
|
||||||
/// Список зарегистрированных адаптеров.
|
/// Список зарегистрированных адаптеров.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public Dictionary<string, IMessangerAdapterSetup> Adapters => _adapters;
|
public Dictionary<string, IMessengerAdapterSetup> Adapters => _adapters;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Зарегистрировать адаптер для указанного типа мессенджера.
|
/// Зарегистрировать адаптер для указанного типа мессенджера.
|
||||||
@@ -25,7 +25,7 @@ public sealed class MultiAdapterFactory : IMessengerAdapterFactory
|
|||||||
/// <returns>
|
/// <returns>
|
||||||
/// Текущий экземпляр <see cref="MultiAdapterFactory"/> для цепочки вызовов.
|
/// Текущий экземпляр <see cref="MultiAdapterFactory"/> для цепочки вызовов.
|
||||||
/// </returns>
|
/// </returns>
|
||||||
public IMessengerAdapterFactory Register(string messengerType, IMessangerAdapterSetup adapter)
|
public IMessengerAdapterFactory Register(string messengerType, IMessengerAdapterSetup adapter)
|
||||||
{
|
{
|
||||||
_adapters[messengerType] = adapter;
|
_adapters[messengerType] = adapter;
|
||||||
return this;
|
return this;
|
||||||
|
|||||||
42
BotPages.Core/Abstractions/SendRequest.cs
Normal file
42
BotPages.Core/Abstractions/SendRequest.cs
Normal 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; }
|
||||||
|
}
|
||||||
@@ -40,7 +40,7 @@ public sealed class BotPagesApp
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Добавить адаптер.
|
/// Добавить адаптер.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public BotPagesApp AddAdapter(string messengerType, IMessangerAdapterSetup adapter)
|
public BotPagesApp AddAdapter(string messengerType, IMessengerAdapterSetup adapter)
|
||||||
{
|
{
|
||||||
_adapterFactory.Register(messengerType, adapter);
|
_adapterFactory.Register(messengerType, adapter);
|
||||||
return this;
|
return this;
|
||||||
|
|||||||
@@ -1,6 +1,4 @@
|
|||||||
using BotPages.Core.Abstractions;
|
namespace BotPages.Core;
|
||||||
|
|
||||||
namespace BotPages.Core;
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Данные чата.
|
/// Данные чата.
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
using BotPages.Core.Abstractions;
|
using BotPages.Core.Abstractions;
|
||||||
using BotPages.Core.Context;
|
using BotPages.Core.Context;
|
||||||
using BotPages.Core.Messaging;
|
|
||||||
|
|
||||||
namespace BotPages.Core;
|
namespace BotPages.Core;
|
||||||
|
|
||||||
|
|||||||
@@ -1,41 +1,22 @@
|
|||||||
using BotPages.Core.Abstractions;
|
using BotPages.Core.Abstractions;
|
||||||
using BotPages.Core.Messaging;
|
|
||||||
|
|
||||||
namespace BotPages.Core;
|
namespace BotPages.Core;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Расширения <see cref="PageContext"/> для работы с <see cref="IMessengerAdapter"/>
|
/// Расширения <see cref="PageContext"/> для работы с адаптером.
|
||||||
|
/// Упрощают создание универсального `SendRequest`.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public static class PageContextAdapterExtensions
|
public static class PageContextAdapterExtensions
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Отправить текстовое сообщение.
|
/// Отправить сообщение универсальным запросом через привязанный адаптер.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public static Task<string?> SendTextAsync(this PageContext ctx,
|
public static Task<string?> SendAsync(this PageContext ctx, SendRequest request, CancellationToken ct = default)
|
||||||
string text,
|
=> ctx.Adapter.SendAsync(request, ct);
|
||||||
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);
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Отправить файл.
|
/// Удалить сообщение через привязанный адаптер.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public static Task SendFileAsync(this PageContext ctx,
|
public static Task DeleteAsync(this PageContext ctx, string chatId, string messageId, CancellationToken ct = default)
|
||||||
FileDescriptor file,
|
=> ctx.Adapter.DeleteAsync(chatId, messageId, ct);
|
||||||
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);
|
|
||||||
}
|
}
|
||||||
@@ -4,6 +4,7 @@ namespace BotPages.Core.Messaging;
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Fluent‑билдер для отправки сообщений (текст, кнопки, файлы, альбомы, прогресс).
|
/// Fluent‑билдер для отправки сообщений (текст, кнопки, файлы, альбомы, прогресс).
|
||||||
|
/// Поддерживает указание адаптер-специфичных опций через `WithAdapterOption`.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class MessageBuilder
|
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)> _files = new();
|
||||||
private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _album = new();
|
private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _album = new();
|
||||||
private bool _disableReplyKeyboard;
|
private bool _disableReplyKeyboard;
|
||||||
private string? _editMessageId = null;
|
private AdapterOptionsBag? _adapterOptions = null;
|
||||||
|
private string? _chatId = null;
|
||||||
|
|
||||||
/// <summary>Создать билдер сообщений.</summary>
|
/// <summary>Создать билдер сообщений.</summary>
|
||||||
public MessageBuilder(PageContext ctx) => _ctx = ctx;
|
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>
|
/// <summary>Текст сообщения.</summary>
|
||||||
public MessageBuilder Text(string text, MessageFormat format = MessageFormat.Plain)
|
public MessageBuilder Text(string text, MessageFormat format = MessageFormat.Plain)
|
||||||
{
|
{
|
||||||
@@ -28,13 +47,6 @@ public sealed class MessageBuilder
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Редактировать сообщение.</summary>
|
|
||||||
public MessageBuilder EditMessage(string messagId)
|
|
||||||
{
|
|
||||||
_editMessageId = messagId;
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>Добавить inline‑кнопку.</summary>
|
/// <summary>Добавить inline‑кнопку.</summary>
|
||||||
public MessageBuilder Inline(string label, string value)
|
public MessageBuilder Inline(string label, string value)
|
||||||
{
|
{
|
||||||
@@ -63,7 +75,7 @@ public sealed class MessageBuilder
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Добавить строку inline‑кнопок.</summary>
|
/// <summary>Добавить строки inline‑кнопок.</summary>
|
||||||
public MessageBuilder Inline(IEnumerable<IEnumerable<InlineButton>> row)
|
public MessageBuilder Inline(IEnumerable<IEnumerable<InlineButton>> row)
|
||||||
{
|
{
|
||||||
_inline.AddRange(row.Select(t => t.ToList()).ToList());
|
_inline.AddRange(row.Select(t => t.ToList()).ToList());
|
||||||
@@ -73,7 +85,6 @@ public sealed class MessageBuilder
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Отключение Reply клавиатуры.
|
/// Отключение Reply клавиатуры.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <returns></returns>
|
|
||||||
public MessageBuilder DisableReply()
|
public MessageBuilder DisableReply()
|
||||||
{
|
{
|
||||||
_disableReplyKeyboard = true;
|
_disableReplyKeyboard = true;
|
||||||
@@ -96,7 +107,7 @@ public sealed class MessageBuilder
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Добавить строку reply‑кнопок.</summary>
|
/// <summary>Добавить строки reply‑кнопок.</summary>
|
||||||
public MessageBuilder Reply(IEnumerable<IEnumerable<ReplyButton>> row)
|
public MessageBuilder Reply(IEnumerable<IEnumerable<ReplyButton>> row)
|
||||||
{
|
{
|
||||||
_disableReplyKeyboard = false;
|
_disableReplyKeyboard = false;
|
||||||
@@ -118,10 +129,20 @@ public sealed class MessageBuilder
|
|||||||
return this;
|
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>
|
/// <summary>Отправить собранное сообщение.</summary>
|
||||||
public async Task<string?> SendAsync(CancellationToken ct = default)
|
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;
|
List<List<ReplyButton>>? reply = null;
|
||||||
if (_disableReplyKeyboard) reply = new();
|
if (_disableReplyKeyboard) reply = new();
|
||||||
@@ -130,18 +151,38 @@ public sealed class MessageBuilder
|
|||||||
// Текст
|
// Текст
|
||||||
if (!string.IsNullOrWhiteSpace(_text))
|
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)
|
foreach (var (file, caption, captionFormat) in _files)
|
||||||
await _ctx.SendFileAsync(file: file
|
{
|
||||||
, caption: caption
|
var req = new SendRequest
|
||||||
, captionFormat: captionFormat
|
{
|
||||||
, reply: reply
|
ChatId = _chatId ?? _ctx.Update.Chat.Id,
|
||||||
, inline: _inline
|
File = file,
|
||||||
, ct: ct
|
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)
|
if (_album.Count > 0)
|
||||||
@@ -156,8 +197,9 @@ public sealed class MessageBuilder
|
|||||||
_files.Clear();
|
_files.Clear();
|
||||||
_album.Clear();
|
_album.Clear();
|
||||||
|
|
||||||
_editMessageId = null;
|
_adapterOptions = null;
|
||||||
|
_chatId = null;
|
||||||
|
|
||||||
return messageId;
|
return outMessageId;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,8 +27,12 @@ public sealed class ErrorHandlingMiddleware : IPageMiddleware
|
|||||||
{
|
{
|
||||||
_logger.Log(LogLevel.Critical, "Unhandled exception in middleware pipeline.", ex);
|
_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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,4 @@
|
|||||||
using System;
|
namespace BotPages.Core.Routing;
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using System.Text;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
|
|
||||||
namespace BotPages.Core.Routing;
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Обработчик команды: получает контекст страницы, аргументы команды и токен отмены.
|
/// Обработчик команды: получает контекст страницы, аргументы команды и токен отмены.
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ internal sealed class RoutesRegistry
|
|||||||
|
|
||||||
internal void Map(Type? type)
|
internal void Map(Type? type)
|
||||||
{
|
{
|
||||||
foreach(var attr in type.GetCustomAttributes<RouteAttribute>(inherit: true))
|
foreach (var attr in type.GetCustomAttributes<RouteAttribute>(inherit: true))
|
||||||
{
|
{
|
||||||
_routes.Add(attr.Template, type);
|
_routes.Add(attr.Template, type);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,8 +15,14 @@ public static class BotPagesAppExtension
|
|||||||
/// <param name="messengerType"></param>
|
/// <param name="messengerType"></param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
public static BotPagesApp AddTelegramAdapter(this BotPagesApp app, string token, string messengerType = "")
|
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;
|
if (!string.IsNullOrWhiteSpace(messengerType)) telegram.MessengerType = messengerType;
|
||||||
|
|
||||||
|
|||||||
19
BotPages.Telegram/MessageBuilderExtensions.cs
Normal file
19
BotPages.Telegram/MessageBuilderExtensions.cs
Normal 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);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -21,11 +21,14 @@ namespace BotPages.Telegram;
|
|||||||
/// Адаптер для Telegram на базе Telegram.Bot.
|
/// Адаптер для Telegram на базе Telegram.Bot.
|
||||||
/// Реализует отправку текста, кнопок, файлов, альбомов и прогресса.
|
/// Реализует отправку текста, кнопок, файлов, альбомов и прогресса.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class TelegramAdapter : IMessangerAdapterSetup
|
public sealed class TelegramAdapter : IMessengerAdapterSetup
|
||||||
{
|
{
|
||||||
|
internal static readonly string AdapterType = typeof(TelegramAdapter).FullName;
|
||||||
|
|
||||||
private readonly ILogger _logger;
|
private readonly ILogger _logger;
|
||||||
private TelegramBotClient? _client;
|
private TelegramBotClient? _client;
|
||||||
private string _token;
|
private string _token;
|
||||||
|
private readonly TelegramOptions _options;
|
||||||
private static Capabilities _capabilities = new()
|
private static Capabilities _capabilities = new()
|
||||||
{
|
{
|
||||||
SupportsInlineButtons = true,
|
SupportsInlineButtons = true,
|
||||||
@@ -37,10 +40,11 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
|
|||||||
};
|
};
|
||||||
|
|
||||||
/// <summary>Создать адаптер Telegram.</summary>
|
/// <summary>Создать адаптер Telegram.</summary>
|
||||||
public TelegramAdapter(ILogger logger, string token)
|
public TelegramAdapter(ILogger logger, string token, TelegramOptions? options = null)
|
||||||
{
|
{
|
||||||
_logger = logger;
|
_logger = logger;
|
||||||
_token = token;
|
_token = token;
|
||||||
|
_options = options ?? new TelegramOptions();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -81,6 +85,7 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
|
|||||||
cancellationToken: ct
|
cancellationToken: ct
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|
||||||
await _client.SetMyCommands(commands.Where(t => t.Publish).Select(t => new BotCommand(t.Name, t.Description ?? t.Name.TrimStart('/'))), 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();
|
var me = await _client.GetMe();
|
||||||
@@ -89,13 +94,11 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public async Task<string?> SendTextAsync(string chatId, string text,
|
/// Универсальный внутренний метод отправки — определяет, нужно ли отправлять текст или файл по параметрам.
|
||||||
MessageFormat format = MessageFormat.Plain,
|
/// Возвращает id сообщения (или null).
|
||||||
IEnumerable<IEnumerable<InlineButton>>? inline = null,
|
/// </summary>
|
||||||
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
|
public async Task<string?> SendAsync(SendRequest req, CancellationToken ct)
|
||||||
string? messageId = null,
|
|
||||||
CancellationToken ct = default)
|
|
||||||
{
|
{
|
||||||
if (_client is null)
|
if (_client is null)
|
||||||
{
|
{
|
||||||
@@ -103,206 +106,162 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
InlineKeyboardMarkup? inlineMarkup = null;
|
// Определите параметры адаптера (TelegramOptions) из папки или используйте параметры адаптера по умолчанию.
|
||||||
ReplyMarkup? markup = null;
|
TelegramOptions telegramOptions = _options;
|
||||||
|
if (req.AdapterOptions is AdapterOptionsBag bag && bag.TryGet(AdapterType, out TelegramOptions? opt) && opt is not null)
|
||||||
if (inline is not null && inline.Any())
|
|
||||||
{
|
{
|
||||||
inlineMarkup = new InlineKeyboardMarkup(
|
telegramOptions = opt;
|
||||||
inline.Select(row => row.Select(b => new InlineKeyboardButton(b.Label, b.Value)).ToArray())
|
|
||||||
.ToArray()
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
else if (reply is not null)
|
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 (reply.Any())
|
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()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private ReplyMarkup? BuildReplyMarkup(IEnumerable<IEnumerable<ReplyButton>>? reply)
|
||||||
|
{
|
||||||
|
if (reply is null) return null;
|
||||||
|
|
||||||
|
if (reply.Any())
|
||||||
|
{
|
||||||
|
return new ReplyKeyboardMarkup(reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray())
|
||||||
{
|
{
|
||||||
markup = new ReplyKeyboardMarkup(
|
ResizeKeyboard = true
|
||||||
reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray()
|
};
|
||||||
)
|
|
||||||
{
|
|
||||||
ResizeKeyboard = true
|
|
||||||
};
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
markup = new ReplyKeyboardRemove();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
else
|
||||||
var parseMode = ParseMode.None;
|
|
||||||
|
|
||||||
switch (format)
|
|
||||||
{
|
{
|
||||||
case MessageFormat.Html:
|
return new ReplyKeyboardRemove();
|
||||||
{
|
}
|
||||||
parseMode = ParseMode.Html;
|
}
|
||||||
break;
|
|
||||||
}
|
private static ParseMode GetParseMode(MessageFormat? format)
|
||||||
case MessageFormat.Plain:
|
{
|
||||||
{
|
return format switch
|
||||||
parseMode = ParseMode.None;
|
{
|
||||||
break;
|
MessageFormat.Html => ParseMode.Html,
|
||||||
}
|
MessageFormat.Markdown => ParseMode.MarkdownV2,
|
||||||
case MessageFormat.Markdown:
|
_ => ParseMode.None,
|
||||||
{
|
};
|
||||||
parseMode = ParseMode.MarkdownV2;
|
}
|
||||||
break;
|
|
||||||
}
|
private async Task<InputFile> CreateInputFileAsync(FileDescriptor file, CancellationToken ct)
|
||||||
default:
|
{
|
||||||
{
|
Stream? stream = null;
|
||||||
_logger.Log(LogLevel.Warn, $"MessageFormat '{format}' not supported. Degraded to plain text.");
|
if (file.GetStreamAsync is not null)
|
||||||
break;
|
{
|
||||||
}
|
stream = await file.GetStreamAsync(ct);
|
||||||
|
if (stream is not null) stream.Position = 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Длина сообщения
|
if (stream is not null && stream != Stream.Null)
|
||||||
|
{
|
||||||
|
return new InputFileStream(stream, file.Name);
|
||||||
|
}
|
||||||
|
else if (file.Id.StartsWith("http://") || file.Id.StartsWith("https://"))
|
||||||
|
{
|
||||||
|
return new InputFileUrl(file.Id);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
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)
|
if (text.Length > Capabilities.MaxMessageLength)
|
||||||
{
|
{
|
||||||
_logger.Log(LogLevel.Warn, $"Message too long ({text.Length}). Truncated to {Capabilities.MaxMessageLength}.");
|
_logger.Log(LogLevel.Warn, $"Message too long ({text.Length}). Truncated to {Capabilities.MaxMessageLength}.");
|
||||||
text = text.Substring(0, Capabilities.MaxMessageLength);
|
text = text.Substring(0, Capabilities.MaxMessageLength);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!string.IsNullOrWhiteSpace(messageId))
|
if (!string.IsNullOrWhiteSpace(req.MessageId))
|
||||||
{
|
{
|
||||||
await _client.EditMessageText(
|
await _client.EditMessageText(
|
||||||
messageId: int.Parse(messageId),
|
messageId: int.Parse(req.MessageId),
|
||||||
chatId: long.Parse(chatId),
|
chatId: long.Parse(req.ChatId),
|
||||||
text: text,
|
text: text,
|
||||||
parseMode: parseMode,
|
parseMode: parseMode,
|
||||||
replyMarkup: inlineMarkup,
|
replyMarkup: inlineMarkup,
|
||||||
cancellationToken: ct
|
cancellationToken: ct
|
||||||
);
|
);
|
||||||
|
|
||||||
return messageId;
|
return req.MessageId;
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
if (inlineMarkup is not null) markup = inlineMarkup;
|
if (inlineMarkup is not null) markup = inlineMarkup;
|
||||||
|
|
||||||
var message = await _client.SendMessage(
|
var message = await _client.SendMessage(
|
||||||
chatId: long.Parse(chatId),
|
chatId: long.Parse(req.ChatId),
|
||||||
text: text,
|
text: text,
|
||||||
parseMode: parseMode,
|
parseMode: parseMode,
|
||||||
replyMarkup: markup,
|
replyMarkup: markup,
|
||||||
|
disableNotification: disableNotification,
|
||||||
cancellationToken: ct
|
cancellationToken: ct
|
||||||
);
|
);
|
||||||
|
|
||||||
return message.Id.ToString();
|
return message.MessageId.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;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -53,7 +53,17 @@ public sealed class TelegramAlbumBuilder : IAlbumBuilder
|
|||||||
{
|
{
|
||||||
_logger.Log(LogLevel.Warn, "Albums not supported. Degraded to sequential sends.");
|
_logger.Log(LogLevel.Warn, "Albums not supported. Degraded to sequential sends.");
|
||||||
foreach (var (file, caption, captionFormat) in _items)
|
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;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -95,7 +105,16 @@ public sealed class TelegramAlbumBuilder : IAlbumBuilder
|
|||||||
{
|
{
|
||||||
// Telegram не поддерживает document в альбомах — деградация
|
// Telegram не поддерживает document в альбомах — деградация
|
||||||
_logger.Log(LogLevel.Warn, $"Document '{file.Kind}' in album not supported. Sending document separately.");
|
_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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
14
BotPages.Telegram/TelegramOptions.cs
Normal file
14
BotPages.Telegram/TelegramOptions.cs
Normal 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 и т.д.
|
||||||
|
}
|
||||||
@@ -6,7 +6,6 @@ namespace Demo.Pages;
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Страница ввода деталей заявки.
|
/// Страница ввода деталей заявки.
|
||||||
/// Страница с параметрами и получением состояния.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class DetailsPage : StatefullPage<string>
|
public sealed class DetailsPage : StatefullPage<string>
|
||||||
{
|
{
|
||||||
@@ -32,19 +31,14 @@ public sealed class DetailsPage : StatefullPage<string>
|
|||||||
switch (payload)
|
switch (payload)
|
||||||
{
|
{
|
||||||
case "next":
|
case "next":
|
||||||
{
|
await SaveState(ctx, ct);
|
||||||
await SaveState(ctx, ct);
|
await ctx.Navigation.GoToAsync<FilesPage>(ctx, ct);
|
||||||
await ctx.Navigation.GoToAsync<FilesPage>(ctx, ct);
|
break;
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
case "back":
|
case "back":
|
||||||
{
|
await ctx.Navigation.GoToAsync<TitlePage>(ctx, ct);
|
||||||
await ctx.Navigation.GoToAsync<TitlePage>(ctx, ct);
|
break;
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public override async Task OnText(PageContext ctx, string text, CancellationToken ct)
|
public override async Task OnText(PageContext ctx, string text, CancellationToken ct)
|
||||||
@@ -61,7 +55,6 @@ public sealed class DetailsPage : StatefullPage<string>
|
|||||||
string? title = "";
|
string? title = "";
|
||||||
args?.TryGetValue("title", out title);
|
args?.TryGetValue("title", out title);
|
||||||
|
|
||||||
// Навигация на страницу по имени
|
|
||||||
await ctx.Navigation.GoToAsync<DetailsPage, string>(ctx, title ?? "", ct);
|
await ctx.Navigation.GoToAsync<DetailsPage, string>(ctx, title ?? "", ct);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -8,14 +8,14 @@ namespace Demo.Pages;
|
|||||||
[Route("FileSend")]
|
[Route("FileSend")]
|
||||||
public sealed class FileSendPage : SingletonPage
|
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 content = "Hello from BotPages! This file is generated on the fly.";
|
||||||
var stream = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(content));
|
var stream = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(content));
|
||||||
|
|
||||||
var demoFile = new FileDescriptor
|
var demoFile = new FileDescriptor
|
||||||
{
|
{
|
||||||
Id = "", // не используется при отправке нового файла
|
Id = "",
|
||||||
Name = "demo.txt",
|
Name = "demo.txt",
|
||||||
Extension = "txt",
|
Extension = "txt",
|
||||||
Size = stream.Length,
|
Size = stream.Length,
|
||||||
@@ -23,9 +23,11 @@ public sealed class FileSendPage : SingletonPage
|
|||||||
GetStreamAsync = _ => Task.FromResult<Stream>(stream)
|
GetStreamAsync = _ => Task.FromResult<Stream>(stream)
|
||||||
};
|
};
|
||||||
|
|
||||||
return new MessageBuilder(ctx)
|
var msg = await new MessageBuilder(ctx)
|
||||||
.Text("Вот пример отправки нового файла 📎", MessageFormat.Markdown)
|
.Text("Вот пример отправки нового файла 📎", MessageFormat.Markdown)
|
||||||
.File(demoFile, "Демонстрационный файл")
|
.File(demoFile, "Демонстрационный файл")
|
||||||
.SendAsync(ct);
|
.SendAsync(ct);
|
||||||
|
|
||||||
|
await ctx.GoToHomeAsync(ct);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ namespace Demo.Pages;
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Страница загрузки файлов.
|
/// Страница загрузки файлов.
|
||||||
/// Обычная страница с полученим и сохранением состояния.
|
/// Обычная страница с получением и сохранением состояния.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class FilesPage : SingletonPage
|
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)
|
public override async Task OnFile(PageContext ctx, List<FileDescriptor> files, CancellationToken ct)
|
||||||
{
|
{
|
||||||
|
// Пересылаем каждый файл обратно с подтверждением
|
||||||
foreach (var file in files)
|
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);
|
var request = await ctx.StateStorage.GetAsync<Models.Request>(ctx.SessionKey, "Request", ct);
|
||||||
request.FilesCount = files.Count;
|
request.FilesCount = files.Count;
|
||||||
//Обращение через Context
|
|
||||||
await ctx.SetStorageAsync("Request", request, ct);
|
await ctx.SetStorageAsync("Request", request, ct);
|
||||||
|
|
||||||
await new MessageBuilder(ctx)
|
await new MessageBuilder(ctx)
|
||||||
|
|||||||
@@ -10,9 +10,7 @@ public sealed class SubmitPage : SingletonPage
|
|||||||
{
|
{
|
||||||
public override async Task OnEnter(PageContext ctx, CancellationToken ct)
|
public override async Task OnEnter(PageContext ctx, CancellationToken ct)
|
||||||
{
|
{
|
||||||
var progress = new MessageBuilder(ctx);
|
var messageId = await new MessageBuilder(ctx)
|
||||||
|
|
||||||
var messageId = await progress
|
|
||||||
.Text("Отправка заявки\n7%")
|
.Text("Отправка заявки\n7%")
|
||||||
.SendAsync(ct);
|
.SendAsync(ct);
|
||||||
|
|
||||||
@@ -21,10 +19,9 @@ public sealed class SubmitPage : SingletonPage
|
|||||||
{
|
{
|
||||||
i += 25;
|
i += 25;
|
||||||
Thread.Sleep(TimeSpan.FromMilliseconds(200));
|
Thread.Sleep(TimeSpan.FromMilliseconds(200));
|
||||||
await progress
|
await new MessageBuilder(ctx)
|
||||||
.Text($"Отправка заявки\n{i}%")
|
.Text($"Отправка заявки\n{i}%")
|
||||||
.EditMessage(messageId!)
|
.SendAsync(messageId, ct);
|
||||||
.SendAsync(ct);
|
|
||||||
}
|
}
|
||||||
while (i < 100);
|
while (i < 100);
|
||||||
|
|
||||||
|
|||||||
@@ -1,12 +1,10 @@
|
|||||||
using BotPages.Core;
|
using BotPages.Core;
|
||||||
using BotPages.Core.Abstractions;
|
using BotPages.Core.Abstractions;
|
||||||
using BotPages.Core.Messaging;
|
using BotPages.Core.Messaging;
|
||||||
using BotPages.Core.Routing;
|
|
||||||
|
|
||||||
namespace Demo.Pages;
|
namespace Demo.Pages;
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Страница ввода заголовка заявки.
|
/// Страница ввода заголовка заявки.
|
||||||
/// Обычная страница вводом текста.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class TitlePage : SingletonPage
|
public sealed class TitlePage : SingletonPage
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ namespace Demo.Pages;
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Стартовая страница демо‑бота.
|
/// Стартовая страница демо‑бота.
|
||||||
/// Обычная страница с кнопками
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("Welcome")]
|
[Route("Welcome")]
|
||||||
public sealed class WelcomePage : SingletonPage
|
public sealed class WelcomePage : SingletonPage
|
||||||
@@ -31,19 +30,13 @@ public sealed class WelcomePage : SingletonPage
|
|||||||
switch (button)
|
switch (button)
|
||||||
{
|
{
|
||||||
case WelcomePageButtons.CreateRequest:
|
case WelcomePageButtons.CreateRequest:
|
||||||
{
|
return ctx.Navigation.GoToAsync<TitlePage>(ctx, ct);
|
||||||
return ctx.Navigation.GoToAsync<TitlePage>(ctx, ct);
|
|
||||||
}
|
|
||||||
|
|
||||||
case WelcomePageButtons.Help:
|
case WelcomePageButtons.Help:
|
||||||
{
|
return new MessageBuilder(ctx).Text("Здесь будет справка.", MessageFormat.Plain).SendAsync(ct);
|
||||||
return new MessageBuilder(ctx).Text("Здесь будет справка.", MessageFormat.Plain).SendAsync(ct);
|
|
||||||
}
|
|
||||||
|
|
||||||
case WelcomePageButtons.SendFile:
|
case WelcomePageButtons.SendFile:
|
||||||
{
|
return ctx.Navigation.GoToAsync<FileSendPage>(ctx, ct);
|
||||||
return ctx.Navigation.GoToAsync<FileSendPage>(ctx, ct);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return base.OnText(ctx, text, ct);
|
return base.OnText(ctx, text, ct);
|
||||||
|
|||||||
@@ -26,7 +26,13 @@ namespace Demo
|
|||||||
{
|
{
|
||||||
if (args is null || !args.TryGetValue("page", out var pageName))
|
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;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -37,7 +43,7 @@ namespace Demo
|
|||||||
var app = new BotPagesApp(state, logger)
|
var app = new BotPagesApp(state, logger)
|
||||||
.AddDefaultPage<WelcomePage>()
|
.AddDefaultPage<WelcomePage>()
|
||||||
.MapCommand<WelcomePage>("/start", true, "Главная")
|
.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)
|
.MapCommand(DetailsPage.Command, DetailsPage.CommandHandler, true, DetailsPage.CommandDescription)
|
||||||
.AutoMapRoute()
|
.AutoMapRoute()
|
||||||
.AddMiddleware(new ErrorHandlingMiddleware(logger))
|
.AddMiddleware(new ErrorHandlingMiddleware(logger))
|
||||||
|
|||||||
142
README.md
142
README.md
@@ -1,92 +1,82 @@
|
|||||||
# BotPages Framework
|
# BotPages
|
||||||
|
|
||||||
BotPages — это архитектурный фреймворк для построения Telegram/MAX‑ботов с чистыми слоями, расширяемыми API и удобным developer experience.
|
BotPages — кроссплатформенный фреймворк для создания диалоговых ботов с моделью страниц (page‑based conversational framework).
|
||||||
|
|
||||||
## ✨ Возможности
|
Цели проекта:
|
||||||
- **Навигация через страницы**: каждая страница — отдельный обработчик логики.
|
- Простая модель страниц и навигации.
|
||||||
- **Единый метод GoToAsync**: автоматически поддерживает как `SingletonPage`, так и `StatefulPage`.
|
- Портируемость между мессенджерами через адаптеры.
|
||||||
- **StatefulPage**: свойства автоматически сохраняются в `StateStorage`.
|
- Поддержка middleware и декларативной системы команд.
|
||||||
- **SingletonPage**: один экземпляр на всё приложение, без состояния.
|
- Минимум boilerplate и удобный developer experience.
|
||||||
- **Middleware**: подключение промежуточных обработчиков (логирование, обработка ошибок).
|
|
||||||
- **Автоматическая регистрация страниц**: через рефлексию.
|
|
||||||
- **Роутинг страниц**: возможность устанавливать пути вызова для страниц.
|
|
||||||
- **Команды**: возможность установки команд, которые работают приоритетнее обработчиков страниц.
|
|
||||||
- **Минимум boilerplate**: декларативные интерфейсы и fluent API.
|
|
||||||
|
|
||||||
## 🚀 Быстрый старт
|
Структура репозитория
|
||||||
```csharp
|
|
||||||
var app = new BotPagesApp(factory, state, logger)
|
- `BotPages.Core` — ядро фреймворка: навигация, страницы, маршрутизация, реестр команд, middleware, абстракции адаптеров и хранилища состояния.
|
||||||
.UseDefaultPage<WelcomePage>()
|
- `BotPages.Telegram` — адаптер для Telegram Bot API (реализация `IMessengerAdapter`).
|
||||||
.MapCommand<WelcomePage>("/start")
|
- `Demo` — пример приложения с несколькими страницами и конфигурацией адаптера.
|
||||||
.AddMiddleware(new LoggingMiddleware(logger))
|
- `BotPages` — мета‑проект для упаковки библиотек.
|
||||||
.AddMiddleware(new ErrorHandlingMiddleware(logger));
|
- `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
|
```bash
|
||||||
```csharp
|
dotnet build
|
||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### SingletonPage
|
3. Запуск демо (Telegram):
|
||||||
```csharp
|
|
||||||
public sealed class HelpPage : SingletonPage
|
- Установите переменную окружения `TELEGRAM_TOKEN` с токеном бота.
|
||||||
{
|
|
||||||
public override Task OnEnter(PageContext ctx, CancellationToken ct)
|
```bash
|
||||||
=> ctx.SendTextAsync("Это справка 📖", ct: ct);
|
setx TELEGRAM_TOKEN "<token>" # Windows
|
||||||
}
|
export TELEGRAM_TOKEN="<token>" # Linux/macOS
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🧩 Навигация
|
- Запустите demo:
|
||||||
```csharp
|
|
||||||
await ctx.Navigation.GoToAsync<WelcomePage>(ctx, ct); // Stateful
|
```bash
|
||||||
await ctx.Navigation.GoToAsync<WelcomePage>(ctx, agrs, ct); // Stateful with arguments
|
dotnet run --project Demo
|
||||||
await ctx.Navigation.GoToAsync<HelpPage>(ctx, ct); // Singleton
|
|
||||||
await ctx.Navigation.GoToHome(ctx, ct); // Stateful
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## ⚙️ 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)
|
```csharp
|
||||||
{
|
var app = new BotPagesApp(stateStorage, logger)
|
||||||
_logger.Log(LogLevel.Info, $"Update: {ctx.Update.Kind}");
|
.AddTelegramAdapter(token)
|
||||||
await next();
|
.AddDefaultPage<WelcomePage>()
|
||||||
}
|
.MapCommand<WelcomePage>('/start')
|
||||||
}
|
.AddMiddleware(new LoggingMiddleware(logger));
|
||||||
|
|
||||||
|
await app.Build(CancellationToken.None);
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🏗 Архитектурные принципы
|
Ключевые концепции
|
||||||
- **Separation of concerns**: страницы не знают о транспорте, всё через адаптеры.
|
|
||||||
- **Расширяемость**: новые страницы и middleware подключаются декларативно.
|
|
||||||
- **Прозрачность**: минимум скрытой логики, всё явно через контекст.
|
|
||||||
- **Developer Experience**: удобные API, автоматическая регистрация, документация через `///summary`.
|
|
||||||
|
|
||||||
## 📌 Итог
|
- `SendRequest` — единый формат запроса на отправку (текст, файлы, кнопки, опции). Адаптеры реализуют `IMessengerAdapter.SendAsync(SendRequest)`.
|
||||||
BotPages позволяет писать чистые, расширяемые и удобные для команды боты:
|
- `Page`, `StatefulPage`, `SingletonPage` — модели страниц с жизненным циклом (`OnEnter`, `OnUpdate`, `OnText`, `OnButton`, `OnFile`, `OnError`).
|
||||||
- минимум boilerplate,
|
- `NavigationService` — управление переходами между страницами.
|
||||||
- декларативные интерфейсы,
|
- `IPageMiddleware` — middleware-конвейер, выполняющийся для каждого апдейта.
|
||||||
- прозрачная навигация,
|
|
||||||
- автоматическое управление состоянием.
|
Документация
|
||||||
|
|
||||||
|
Полная внутренняя документация находится в `docs/`:
|
||||||
|
- `docs/GETTING_STARTED.md` — быстрый старт и примеры конфигурации.
|
||||||
|
- `docs/API_REFERENCE.md` — краткий reference публичных API.
|
||||||
|
- `docs/PROJECT_DOCUMENTATION.md` — обзор архитектуры и компонентов.
|
||||||
|
|
||||||
|
Лицензия
|
||||||
|
|
||||||
|
Проект распространяется под лицензией MIT. Смотрите файл `LICENSE`.
|
||||||
162
TZ.md
162
TZ.md
@@ -1,162 +0,0 @@
|
|||||||
# Техническое задание
|
|
||||||
## Проект: BotPages
|
|
||||||
|
|
||||||
### 1. Общая информация
|
|
||||||
- **Название:** BotPages
|
|
||||||
- **Цель:** Создание библиотеки (NuGet‑пакета) для управления страницами в ботах (Telegram, VK, Discord, WhatsApp и др.), позволяющей строить логику без жёсткой привязки к конкретному API.
|
|
||||||
- **Платформа:** .NET 8
|
|
||||||
- **Артефакты:**
|
|
||||||
- `BotPages.Core` — ядро, независимое от транспорта.
|
|
||||||
- `BotPages.Telegram` — адаптер для Telegram.
|
|
||||||
- В будущем: адаптеры для VK, Discord, WhatsApp.
|
|
||||||
- **Демо:** `Demo.exe` — демонстрация работы (создание заявки через несколько страниц, кнопки, файлы).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 2. Основные понятия
|
|
||||||
- **Page** — класс, отвечающий за состояние экрана бота.
|
|
||||||
- `Page` — базовый класс.
|
|
||||||
- `Page<TArguments>` — страница с аргументами.
|
|
||||||
- **Контекст:**
|
|
||||||
- `UserContext` — данные пользователя (UserId, MessengerType).
|
|
||||||
- `ChatContext` — данные чата (ChatId, Title, ThreadId?, ленивое обновление).
|
|
||||||
- `PageContext` — объединяет UserContext, ChatContext, состояние, навигацию, файлы.
|
|
||||||
- **Состояние:**
|
|
||||||
- `IStateStorage` — универсальный интерфейс хранения.
|
|
||||||
- Базовая реализация: InMemory.
|
|
||||||
- Ключ: `CompositeSessionKey(MessengerType:string, ChatId, UserId)`.
|
|
||||||
- История состояний: опционально (None, LastN, TimeWindow, Full).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 3. Жизненный цикл страницы
|
|
||||||
- Методы (все async, с `CancellationToken`):
|
|
||||||
- `OnEnter(ctx)` — вход.
|
|
||||||
- `OnUpdate(ctx, update)` — общий обработчик.
|
|
||||||
- `OnText(ctx, text)` — текстовые сообщения.
|
|
||||||
- `OnFile(ctx, file)` — файлы.
|
|
||||||
- `OnButton(ctx, action)` — кнопки.
|
|
||||||
- `OnLeave(ctx)` — выход.
|
|
||||||
- `OnError(ctx, exception)` — ошибки.
|
|
||||||
- `OnTimeout(ctx, timeoutInfo)` — таймауты.
|
|
||||||
- Прогресс фоновых операций:
|
|
||||||
- `StartProgress()`, `UpdateProgress(percent)` + событие обновления.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 4. Навигация
|
|
||||||
- Императивный API:
|
|
||||||
```csharp
|
|
||||||
ctx.GoTo<CitySelectionPage>();
|
|
||||||
ctx.GoTo<ConfirmationPage>(new ConfirmationArgs { PhotoId = photoId });
|
|
||||||
ctx.GoTo<DetailsPage>(args => { args.Photo = photoId; });
|
|
||||||
ctx.ReplaceWith<MainPage>();
|
|
||||||
ctx.Back();
|
|
||||||
```
|
|
||||||
- Декларативный роутинг:
|
|
||||||
- Атрибуты `[Route("order/create")]`.
|
|
||||||
- Реестр `routes.Map<CreateOrderPage>("order/create")`.
|
|
||||||
- Проверка конфликтов при старте.
|
|
||||||
- Стек навигации: отдельный пакет `BotPages.Navigation.Stack`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 5. Команды
|
|
||||||
- Команды имеют приоритет над событиями страниц.
|
|
||||||
- Поддержка шаблонов:
|
|
||||||
```csharp
|
|
||||||
app.Commands.Map("/start").To<WelcomePage>();
|
|
||||||
app.Commands.Map("/open {page} {id?}")
|
|
||||||
.To(ctx => ctx.GoToByName(page, new { id }));
|
|
||||||
```
|
|
||||||
- Возможность указать страницу, которая открывается при вводе команды.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 6. Файлы
|
|
||||||
- **FileDescriptor:**
|
|
||||||
- `Id`, `Name`, `Extension`, `Size`, `Mime`, `Type(enum)`, `SourceMessenger`, `GetStreamAsync()`, `Checksum?`.
|
|
||||||
- Отправка:
|
|
||||||
```csharp
|
|
||||||
await ctx.Chat.SendFileAsync(file, caption: "Документ");
|
|
||||||
await ctx.Chat.Files.BeginAlbum().Add(file1).Add(file2).SendAsync();
|
|
||||||
```
|
|
||||||
- Альбомы, сжатие — на уровне адаптера.
|
|
||||||
- Метаданные файлов — временно в контексте, экспорт в состояние вручную.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 7. Адаптеры
|
|
||||||
- Интерфейс `IMessengerAdapter`:
|
|
||||||
- `SendMessage`, `EditMessage`, `DeleteMessage`, `SendFile`, `SendAlbum`.
|
|
||||||
- `ReceiveUpdate`.
|
|
||||||
- `GetChat`, `GetFileStream`.
|
|
||||||
- `AnswerCallback`, `SetTypingIndicator`.
|
|
||||||
- Telegram: первая реализация.
|
|
||||||
- Поддержка **Webhook** и **Polling** (выбор конфигом).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 8. Capabilities
|
|
||||||
- В `ChatContext.Capabilities`:
|
|
||||||
- `SupportsInlineButtons`, `SupportsReplyButtons`, `SupportsAlbums`, `SupportsFormattingMarkdown`, `SupportsFormattingHtml`, `MaxMessageLength`.
|
|
||||||
- Разработчик может проверять возможности.
|
|
||||||
- Адаптер всегда деградирует и логирует `Warn`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 9. Логирование
|
|
||||||
- Уровни: `Info`, `Warn`, `Critical`.
|
|
||||||
- Примеры:
|
|
||||||
- Info: вход на страницу, прогресс.
|
|
||||||
- Warn: деградация возможностей.
|
|
||||||
- Critical: падение хранилища.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 10. Middleware
|
|
||||||
- Интерфейс:
|
|
||||||
```csharp
|
|
||||||
public interface IUpdateMiddleware
|
|
||||||
{
|
|
||||||
Task InvokeAsync(UpdateContext ctx, Func<Task> next, CancellationToken ct);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
- Пример:
|
|
||||||
```csharp
|
|
||||||
app.AddMiddleware<LoggingMiddleware>();
|
|
||||||
app.AddMiddleware<ErrorMiddleware>(params);
|
|
||||||
```
|
|
||||||
- Порядок регистрации = порядок выполнения.
|
|
||||||
- Middleware только для входящих обновлений.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 11. Дефолтная страница
|
|
||||||
- Конфигурация:
|
|
||||||
```csharp
|
|
||||||
app.UseDefaultPage<WelcomePage>();
|
|
||||||
```
|
|
||||||
- Одна дефолтная страница для всех мессенджеров.
|
|
||||||
- Условия не нужны.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 12. Demo.exe
|
|
||||||
- Сценарий: создание заявки.
|
|
||||||
- Страницы:
|
|
||||||
1. **StartPage** — приветствие, кнопка «Создать заявку».
|
|
||||||
2. **TitlePage** — ввод текста.
|
|
||||||
3. **DetailsPage** — доп. поля, inline/reply кнопки.
|
|
||||||
4. **FilesPage** — загрузка файлов, просмотр списка.
|
|
||||||
5. **ConfirmPage** — подтверждение заявки.
|
|
||||||
6. **SubmitPage** — отправка, итоговое сообщение.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 13. TODO (будущие версии)
|
|
||||||
- Поддержка модальных страниц со стеком.
|
|
||||||
- Расширенные Capabilities (rate limits, threads).
|
|
||||||
- View‑DSL как надстройка над контекстом.
|
|
||||||
- Cross‑transport identity.
|
|
||||||
- Расширенные таймауты и политики отката.
|
|
||||||
30
docfx.json
Normal file
30
docfx.json
Normal 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
46
docs/API_REFERENCE.md
Normal 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
19
docs/CONTRIBUTING.md
Normal 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
47
docs/GETTING_STARTED.md
Normal 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.
|
||||||
114
docs/PROJECT_DOCUMENTATION.md
Normal file
114
docs/PROJECT_DOCUMENTATION.md
Normal 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 (список публичных типов и методов) в отдельный документ.
|
||||||
2
docs/docfx_project/docfx.css
Normal file
2
docs/docfx_project/docfx.css
Normal 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; }
|
||||||
7
docs/docfx_project/docfx.js
Normal file
7
docs/docfx_project/docfx.js
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
module.exports = {
|
||||||
|
"templates": {
|
||||||
|
"global": {
|
||||||
|
"favicon": "favicon.ico"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
22
scripts/generate-docs.ps1
Normal file
22
scripts/generate-docs.ps1
Normal 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
14
scripts/generate-docs.sh
Normal 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"
|
||||||
Reference in New Issue
Block a user