2 Commits

Author SHA1 Message Date
4aff8edbcd Доработан менеджер состояний.
All checks were successful
CI / build-test (push) Successful in 31s
Release / pack-and-publish (release) Successful in 1m12s
2025-12-03 07:15:46 +03:00
5feeffe6bf ci
All checks were successful
CI / build-test (push) Successful in 37s
Release / pack-and-publish (release) Successful in 40s
2025-12-02 17:50:32 +03:00
15 changed files with 240 additions and 27 deletions

View File

@@ -25,6 +25,12 @@ jobs:
TAG="${GITHUB_REF_NAME#v}" TAG="${GITHUB_REF_NAME#v}"
echo "PACKAGE_VERSION=$TAG" >> $GITHUB_OUTPUT echo "PACKAGE_VERSION=$TAG" >> $GITHUB_OUTPUT
- name: Replace ProjectReference with PackageReference
run: |
sed -i "s#<ProjectReference Include=\"..\/BotPages.Core\/BotPages.Core.csproj\" />#<PackageReference Include=\"BotPages.Core\" Version=\"${{ steps.version.outputs.PACKAGE_VERSION }}\" />#" BotPages.Telegram/BotPages.Telegram.csproj
sed -i "s#<ProjectReference Include=\"..\/BotPages.Core\/BotPages.Core.csproj\" />#<PackageReference Include=\"BotPages.Core\" Version=\"${{ steps.version.outputs.PACKAGE_VERSION }}\" />#" BotPages/BotPages.csproj
sed -i "s#<ProjectReference Include=\"..\/BotPages.Telegram\/BotPages.Telegram.csproj\" />#<PackageReference Include=\"BotPages.Telegram\" Version=\"${{ steps.version.outputs.PACKAGE_VERSION }}\" />#" BotPages/BotPages.csproj
- name: Build and Pack projects - name: Build and Pack projects
run: | run: |
mkdir -p artifacts mkdir -p artifacts

View File

@@ -8,7 +8,7 @@
/// <summary> /// <summary>
/// Получает состояние пользователя. /// Получает состояние пользователя.
/// </summary> /// </summary>
Task<UserState> GetAsync(long userId, CancellationToken ct); Task<UserState> GetAsync(string transportId, long userId, CancellationToken ct);
/// <summary> /// <summary>
/// Сохраняет состояние пользователя. /// Сохраняет состояние пользователя.

View File

@@ -6,17 +6,21 @@
/// </summary> /// </summary>
public sealed class InMemoryStateStore : IStateStore public sealed class InMemoryStateStore : IStateStore
{ {
private readonly Dictionary<long, UserState> _store = new(); private readonly Dictionary<(string chatClientId, long userId), UserState> _store = new();
/// <summary> /// <summary>
/// Получает состояние пользователя, создавая новое при отсутствии. /// Получает состояние пользователя, создавая новое при отсутствии.
/// </summary> /// </summary>
public Task<UserState> GetAsync(long userId, CancellationToken ct) public Task<UserState> GetAsync(string chatClientId, long userId, CancellationToken ct)
{ {
if (!_store.TryGetValue(userId, out var st)) if (!_store.TryGetValue((chatClientId, userId), out var st))
{ {
st = new UserState { UserId = userId }; st = new UserState
_store[userId] = st; {
UserId = userId,
ChatClientId = chatClientId,
};
_store[(chatClientId, userId)] = st;
} }
return Task.FromResult(st); return Task.FromResult(st);
} }
@@ -26,7 +30,7 @@
/// </summary> /// </summary>
public Task SaveAsync(UserState state, CancellationToken ct) public Task SaveAsync(UserState state, CancellationToken ct)
{ {
_store[state.UserId] = state; _store[(state.ChatClientId, state.UserId)] = state;
return Task.CompletedTask; return Task.CompletedTask;
} }
} }

View File

@@ -22,7 +22,7 @@
/// </summary> /// </summary>
public async Task PushAsync(string pageId, object? args, UpdateContext ctx, CancellationToken ct) public async Task PushAsync(string pageId, object? args, UpdateContext ctx, CancellationToken ct)
{ {
var state = await _store.GetAsync(ctx.User.Id, ct); var state = await _store.GetAsync(ctx.Client.Id, ctx.User.Id, ct);
state.Stack.Add(new NavEntry(pageId, args)); state.Stack.Add(new NavEntry(pageId, args));
await _store.SaveAsync(state, ct); await _store.SaveAsync(state, ct);
@@ -35,7 +35,7 @@
/// </summary> /// </summary>
public async Task ReplaceAsync(string pageId, object? args, UpdateContext ctx, CancellationToken ct) public async Task ReplaceAsync(string pageId, object? args, UpdateContext ctx, CancellationToken ct)
{ {
var state = await _store.GetAsync(ctx.User.Id, ct); var state = await _store.GetAsync(ctx.Client.Id, ctx.User.Id, ct);
if (state.Stack.Count > 0) state.Stack[^1] = new NavEntry(pageId, args); if (state.Stack.Count > 0) state.Stack[^1] = new NavEntry(pageId, args);
else state.Stack.Add(new NavEntry(pageId, args)); else state.Stack.Add(new NavEntry(pageId, args));
await _store.SaveAsync(state, ct); await _store.SaveAsync(state, ct);
@@ -49,7 +49,7 @@
/// </summary> /// </summary>
public async Task PopAsync(UpdateContext ctx, CancellationToken ct) public async Task PopAsync(UpdateContext ctx, CancellationToken ct)
{ {
var state = await _store.GetAsync(ctx.User.Id, ct); var state = await _store.GetAsync(ctx.Client.Id, ctx.User.Id, ct);
if (state.Stack.Count == 0) return; if (state.Stack.Count == 0) return;
var currentId = state.Stack[^1].PageId; var currentId = state.Stack[^1].PageId;
@@ -92,7 +92,7 @@
/// </summary> /// </summary>
public async Task<NavEntry?> CurrentAsync(UpdateContext ctx, CancellationToken ct) public async Task<NavEntry?> CurrentAsync(UpdateContext ctx, CancellationToken ct)
{ {
var state = await _store.GetAsync(ctx.User.Id, ct); var state = await _store.GetAsync(ctx.Client.Id, ctx.User.Id, ct);
return state.Stack.Count == 0 ? null : state.Stack[^1]; return state.Stack.Count == 0 ? null : state.Stack[^1];
} }
@@ -101,7 +101,7 @@
/// </summary> /// </summary>
public async Task<IReadOnlyList<NavEntry>> StackAsync(UpdateContext ctx, CancellationToken ct) public async Task<IReadOnlyList<NavEntry>> StackAsync(UpdateContext ctx, CancellationToken ct)
{ {
var state = await _store.GetAsync(ctx.User.Id, ct); var state = await _store.GetAsync(ctx.Client.Id, ctx.User.Id, ct);
return state.Stack.AsReadOnly(); return state.Stack.AsReadOnly();
} }
} }

View File

@@ -8,7 +8,12 @@
/// <summary> /// <summary>
/// Идентификатор пользователя. /// Идентификатор пользователя.
/// </summary> /// </summary>
public long UserId { get; init; } public required long UserId { get; init; }
/// <summary>
/// Идентификатор клиента чата.
/// </summary>
public required string ChatClientId { get; init; }
/// <summary> /// <summary>
/// Навигационный стек страниц. /// Навигационный стек страниц.

View File

@@ -0,0 +1,20 @@
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace BotPages.Core
{
public class ActionAttribute : Attribute
{
public ActionAttribute(string label)
{
Label = label;
}
public string Label { get; }
}
}

View File

@@ -0,0 +1,48 @@
using System.Reflection;
namespace BotPages.Core
{
public static class ActionExtensions
{
private static readonly Dictionary<Type, Dictionary<string, object>> _cache = new();
public static string GetActionLabel<T>(this T value)
where T : Enum
{
var fieldName = value.ToString();
var field = typeof(T).GetField(fieldName, BindingFlags.Public | BindingFlags.Static);
return field?.GetCustomAttribute<ActionAttribute>()?.Label ?? fieldName;
}
public static T? FromActionLabel<T>(string? value) where T : struct, Enum
{
if (value == null) return null;
var type = typeof(T);
if (!_cache.TryGetValue(type, out var map))
{
map = new Dictionary<string, object>();
var fields = type.GetFields(BindingFlags.Public | BindingFlags.Static);
foreach (var field in fields)
{
var fieldValue = field.GetValue(null)!;
var fieldName = field.Name;
var attr = field.GetCustomAttribute<ActionAttribute>();
if (attr != null)
{
fieldName = attr.Label;
}
map[fieldName] = fieldValue;
}
}
return map.TryGetValue(value, out var result) ? (T)result : null;
}
}
}

View File

@@ -18,11 +18,23 @@
/// <summary> /// <summary>
/// Тип кнопки: inline или reply. /// Тип кнопки: inline или reply.
/// </summary> /// </summary>
public ActionPlacement Placement { get; init; } = ActionPlacement.Inline; public ActionPlacement Placement { get; init; } = ActionPlacement.Reply;
/// <summary> /// <summary>
/// Номер ряда для макета (0 — первая строка). /// Номер ряда для макета (0 — первая строка).
/// </summary> /// </summary>
public int Row { get; init; } = 0; public int Row { get; init; } = 0;
public PageAction()
{
}
public PageAction(Enum en)
{
Label = en.GetActionLabel();
Value = en.ToString();
}
} }
} }

View File

@@ -2,10 +2,15 @@
{ {
/// <summary> /// <summary>
/// Универсальный клиент для отправки сообщений и файлов в чат. /// Универсальный клиент для отправки сообщений и файлов в чат.
/// Адаптеры (Telegram, MAX и др.) реализуют этот интерфейс. /// Адаптеры реализуют этот интерфейс.
/// </summary> /// </summary>
public interface IChatClient public interface IChatClient
{ {
/// <summary>
/// Идентификатор клиента.
/// </summary>
string Id { get; init; }
/// <summary> /// <summary>
/// Отправляет текстовое сообщение. /// Отправляет текстовое сообщение.
/// Может сопровождаться клавиатурой (inline или reply). /// Может сопровождаться клавиатурой (inline или reply).

View File

@@ -14,6 +14,8 @@ namespace BotPages.Telegram
{ {
private readonly ITelegramBotClient _bot; private readonly ITelegramBotClient _bot;
public string Id { get; init; } = nameof(TelegramClientAdapter);
/// <summary> /// <summary>
/// Создаёт адаптер на основе ITelegramBotClient. /// Создаёт адаптер на основе ITelegramBotClient.
/// </summary> /// </summary>

View File

@@ -1,9 +1,11 @@
<Solution> <Solution>
<Folder Name="/Adapters/">
<Project Path="BotPages.Telegram/BotPages.Telegram.csproj" />
</Folder>
<Folder Name="/Элементы решения/"> <Folder Name="/Элементы решения/">
<File Path="README.md" /> <File Path="README.md" />
</Folder> </Folder>
<Project Path="BotPages.Core/BotPages.Core.csproj" /> <Project Path="BotPages.Core/BotPages.Core.csproj" />
<Project Path="BotPages.Telegram/BotPages.Telegram.csproj" />
<Project Path="BotPages/BotPages.csproj" /> <Project Path="BotPages/BotPages.csproj" />
<Project Path="Demo/Demo.csproj" /> <Project Path="Demo/Demo.csproj" />
</Solution> </Solution>

View File

@@ -29,7 +29,4 @@ namespace Demo.Pages
return Task.FromResult(PageResultBuilder.Empty().WithText("Нажмите кнопку 'Назад'.").Build()); return Task.FromResult(PageResultBuilder.Empty().WithText("Нажмите кнопку 'Назад'.").Build());
} }
} }
} }

View File

@@ -10,9 +10,9 @@ namespace Demo.Pages
{ {
var actions = new[] var actions = new[]
{ {
new PageAction { Label = "📌 Inline", Value = "inline", Placement = ActionPlacement.Reply, Row = 0 }, new PageAction(MainPageButtons.Inline) { Placement = ActionPlacement.Reply, Row = 0 },
new PageAction { Label = "⌨️ Reply", Value = "reply", Placement = ActionPlacement.Reply, Row = 1 }, new PageAction(MainPageButtons.Reply) { Placement = ActionPlacement.Reply, Row = 1 },
new PageAction { Label = "📂 Файлы", Value = "files", Placement = ActionPlacement.Reply, Row = 2 } new PageAction(MainPageButtons.Files) { Placement = ActionPlacement.Reply, Row = 2 },
}; };
return Task.FromResult( return Task.FromResult(
@@ -25,14 +25,27 @@ namespace Demo.Pages
public override Task<PageResult> HandleAsync(UpdateContext ctx, CancellationToken ct) public override Task<PageResult> HandleAsync(UpdateContext ctx, CancellationToken ct)
{ {
return ctx.Text switch var button = ActionExtensions.FromActionLabel<MainPageButtons>(ctx.Text);
return button switch
{ {
"📌 Inline" => Task.FromResult(PageResultBuilder.Empty().WithNavigate(nameof(InlinePage)).Build()), MainPageButtons.Inline => Task.FromResult(PageResultBuilder.Empty().WithNavigate(nameof(InlinePage)).Build()),
"⌨️ Reply" => Task.FromResult(PageResultBuilder.Empty().WithNavigate(nameof(ReplyPage)).Build()), MainPageButtons.Reply => Task.FromResult(PageResultBuilder.Empty().WithNavigate(nameof(ReplyPage)).Build()),
"📂 Файлы" => Task.FromResult(PageResultBuilder.Empty().WithNavigate(nameof(FilesPage)).Build()), MainPageButtons.Files => Task.FromResult(PageResultBuilder.Empty().WithNavigate(nameof(FilesPage)).Build()),
_ => Task.FromResult(PageResultBuilder.Empty().WithText("Выберите действие с кнопок.").Build()) _ => Task.FromResult(PageResultBuilder.Empty().WithText("Выберите действие с кнопок.").Build())
}; };
} }
} }
public enum MainPageButtons
{
[Action("📌 Inline")]
Inline,
[Action("⌨️ Reply")]
Reply,
[Action("📂 Файлы")]
Files,
}
} }

101
README.md
View File

@@ -1 +1,100 @@
# BotPages # BotPages.Core
**BotPages.Core** — это универсальный фреймворк для построения ботов с декларативными страницами, навигацией и единым контекстом.
Поддерживает работу сразу с несколькими транспортами (например, Telegram и MAX), сохраняя чистую архитектуру и удобный developer experience.
---
## ✨ Основные идеи
- **PageResult** — декларативный результат обработки страницы (сообщение, файлы, кнопки, навигация).
- **PageMessage** — объект сообщения с поддержкой форматов (Plain/Markdown/HTML), флагов (`IsSilent`, `DisableWebPreview`).
- **PageNavigate** — объект навигации (переход на другую страницу, аргументы, режим Replace).
- **PageAction** — кнопки (inline/reply, ссылки, запрос контакта/локации, стили).
- **UpdateContext** — универсальный контекст обновления, независимый от транспорта, с полем `Transport` для разделения Telegram/MAX.
- **PageRegistry** — реестр страниц, умеет собирать их автоматически из сборки (`CreateFromAssembly`, `CreateFromApplication`).
- **IStateStore** — хранилище состояния пользователя, ключом является `(Transport, ChatId)`.
---
## 🚀 Быстрый старт
```csharp
// Создаём реестр страниц
var registry = PageRegistry.CreateFromApplication(defaultPageId: "main");
// Хранилище состояния
IStateStore store = new InMemoryStateStore();
// Навигация
INavigationService nav = new NavigationService(registry, store);
// Запуск Telegram
var telegramBot = new TelegramBotClient("TELEGRAM_TOKEN");
telegramBot.StartReceiving(async (bot, update, ct) =>
{
var ctx = TelegramUpdateMapper.Map(bot, nav, store, update);
await nav.HandleAsync(ctx, ct);
});
// Запуск MAX
var maxClient = new MaxClientAdapter("MAX_CONFIG");
maxClient.OnUpdate(async (update, ct) =>
{
var ctx = MaxUpdateMapper.Map(maxClient, nav, store, update);
ctx.Transport = "max";
await nav.HandleAsync(ctx, ct);
});
```
---
## 📌 Пример страницы
```csharp
public sealed class MainPage : IPage
{
public string Id => "main";
public PageResult Handle(UpdateContext ctx)
{
return PageResult.Text("🏠 Главная страница", new[]
{
new PageAction { Label = "Перейти", Value = "inlinePage", Placement = ActionPlacement.Inline }
});
}
}
```
---
## 🛠️ Возможности
- ✅ Декларативные страницы (`PageResult`)
- ✅ Навигация (`PageNavigate`)
- ✅ Сообщения с форматами и флагами (`PageMessage`)
- ✅ Кнопки с расширенными параметрами (`PageAction`)
- ✅ Поддержка нескольких транспортов (Telegram)
- ✅ Автоматическая регистрация страниц (`PageRegistry.CreateFromApplication`)
- ✅ Хранение состояния по `(ChatClientId, ChatId)`
---
## 📂 Структура проекта
```
BotPages/
├── BotPages.Core/ # Основные классы (PageResult, PageMessage, PageNavigate, UpdateContext)
├── Demo/ # Пример страниц и запуск
├── Adapters/ # Транспортные адаптеры (Telegram)
└── README.md
```
---
## 📖 TODO
- [ ] Поддержка медиагрупп (альбомов) в Telegram
- [ ] Расширенные стили кнопок
- [ ] TTL для сообщений
- [ ] Плагины для сторонних транспортов