Implement Middleware-based message loop

Examples/MiddlewareBaseBot/Forms/StartForm.cs

@@ -0,0 +1,47 @@
+using TelegramBotBase.Base;
+using TelegramBotBase.Form;
+
+internal sealed class StartForm : FormBase
+{
+    public override async Task PreLoad(MessageResult message)
+    {
+        await this.Device.Send("PreLoad");
+
+        await Task.Delay(200);
+    }
+
+    public override async Task Load(MessageResult message)
+    {
+        await this.Device.Send("Load");
+
+        await Task.Delay(200);
+    }
+
+    public override async Task Edited(MessageResult message)
+    {
+        await this.Device.Send("Edited");
+
+        await Task.Delay(200);
+    }
+
+    public override async Task Action(MessageResult message)
+    {
+        await this.Device.Send("Action");
+
+        await Task.Delay(200);
+    }
+
+    public override async Task SentData(DataResult data)
+    {
+        await this.Device.Send("SentData");
+
+        await Task.Delay(200);
+    }
+
+    public override async Task Render(MessageResult message)
+    {
+        await this.Device.Send("Render");
+
+        await Task.Delay(200);
+    }
+}

Examples/MiddlewareBaseBot/MiddlewareBaseBot.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\TelegramBotBase\TelegramBotBase.csproj" />
+  </ItemGroup>
+
+</Project>

Examples/MiddlewareBaseBot/Program.cs

@@ -0,0 +1,195 @@
+using Telegram.Bot.Types.Enums;
+using TelegramBotBase;
+using TelegramBotBase.Builder;
+using TelegramBotBase.MessageLoops.Extensions;
+
+public class Program
+{
+    private static async Task Main(string[] args)
+    {
+        var bot = GetPhotoBot();
+
+        await bot.Start();
+
+        Console.WriteLine("Bot started :)");
+
+        Console.ReadLine();
+    }
+
+    /// <summary>
+    ///     Creates a bot with middleware message loop and authentication for admin user
+    /// </summary>
+    private static BotBase GetAdminBot()
+    {
+        var bot = BotBaseBuilder
+                    .Create()
+                    .WithAPIKey(Environment.GetEnvironmentVariable("API_KEY") ?? throw new Exception("API_KEY is not set"))
+                    .MiddlewareMessageLoop(
+                        messageLoop =>
+                            messageLoop
+                                .Use(async (container, next) =>
+                                {
+                                    var updateResult = container.UpdateResult;
+                                    if (updateResult.Message is not null)
+                                    {
+                                        if (updateResult.Message.From is not null)
+                                        {
+                                            var fromId = updateResult.Message.From.Id;
+
+                                            if (fromId == 1)
+                                            {
+                                                await next();
+                                            }
+                                        }
+                                    }
+
+                                    return;
+                                })
+                                .UseValidUpdateTypes(
+                                    UpdateType.Message,
+                                    UpdateType.EditedMessage,
+                                    UpdateType.CallbackQuery)
+                                .UseBotCommands()
+                                .UseForms())
+                    .WithStartForm<StartForm>()
+                    .NoProxy()
+                    .DefaultCommands()
+                    .NoSerialization()
+                    .UsePersian()
+                    .Build();
+
+        return bot;
+    }
+
+    /// <summary>
+    ///     Creates a bot with middleware message loop for handle inline queries
+    /// </summary>
+    private static BotBase GetInlineQueryBot()
+    {
+        var bot = BotBaseBuilder
+                    .Create()
+                    .WithAPIKey(Environment.GetEnvironmentVariable("API_KEY") ?? throw new Exception("API_KEY is not set"))
+                    .MiddlewareMessageLoop(
+                        messageLoop =>
+                            messageLoop
+                                .UseValidUpdateTypes(UpdateType.InlineQuery)
+                                .Use(async (container, next) =>
+                                {
+                                    var query = container.UpdateResult.RawData.InlineQuery.Query;
+
+                                    if (!string.IsNullOrWhiteSpace(query))
+                                    {
+                                        // logic
+
+                                        await next();
+                                    }
+
+                                    return;
+                                }))
+                    .WithStartForm<StartForm>()
+                    .NoProxy()
+                    .DefaultCommands()
+                    .NoSerialization()
+                    .UsePersian()
+                    .Build();
+
+        return bot;
+    }
+
+    /// <summary>
+    ///     Creates a bot with middleware message loop like form base message loop
+    /// </summary>
+    private static BotBase GetFormBaseBot()
+    {
+        var bot = BotBaseBuilder
+                            .Create()
+                            .WithAPIKey(Environment.GetEnvironmentVariable("API_KEY") ?? throw new Exception("API_KEY is not set"))
+                            .MiddlewareMessageLoop(
+                                messageLoop =>
+                                    messageLoop
+                                        .UseValidUpdateTypes(
+                                            UpdateType.Message,
+                                            UpdateType.EditedMessage,
+                                            UpdateType.CallbackQuery)
+                                        .UseBotCommands()
+                                        .UseForms())
+                            // OR instead of UseForms 
+                            // .UsePreLoad()
+                            // .UseLoad()
+                            // .UseAllAttachments()
+                            // .UseActions()
+                            // .UseRender()
+                            .WithStartForm<StartForm>()
+                            .NoProxy()
+                            .DefaultCommands()
+                            .NoSerialization()
+                            .UsePersian()
+                            .Build();
+
+        return bot;
+    }
+
+    /// <summary>
+    ///     Creates a bot with middleware message loop like form base message loop
+    /// </summary>
+    private static BotBase GetFullBot()
+    {
+        var bot = BotBaseBuilder
+                            .Create()
+                            .WithAPIKey(Environment.GetEnvironmentVariable("API_KEY") ?? throw new Exception("API_KEY is not set"))
+                            .MiddlewareMessageLoop(
+                                messageLoop =>
+                                    messageLoop
+                                        .UseBotCommands()
+                                        .UseForms())
+                            .WithStartForm<StartForm>()
+                            .NoProxy()
+                            .DefaultCommands()
+                            .NoSerialization()
+                            .UsePersian()
+                            .Build();
+
+        return bot;
+    }
+
+    /// <summary>
+    ///     Creates a bot with middleware message loop like minimal message loop
+    /// </summary>
+    private static BotBase GetMinimalBot()
+    {
+        var bot = BotBaseBuilder
+                            .Create()
+                            .WithAPIKey(Environment.GetEnvironmentVariable("API_KEY") ?? throw new Exception("API_KEY is not set"))
+                            .MiddlewareMessageLoop(
+                                messageLoop =>
+                                    messageLoop
+                                        .UseLoad())
+                            .WithStartForm<StartForm>()
+                            .NoProxy()
+                            .DefaultCommands()
+                            .NoSerialization()
+                            .UsePersian()
+                            .Build();
+
+        return bot;
+    }
+
+    private static BotBase GetPhotoBot()
+    {
+        var bot = BotBaseBuilder
+                    .Create()
+                    .WithAPIKey(Environment.GetEnvironmentVariable("API_KEY") ?? throw new Exception("API_KEY is not set"))
+                    .MiddlewareMessageLoop(
+                        messageLoop =>
+                            messageLoop
+                                .UseAttachments(MessageType.Photo))
+                    .WithStartForm<StartForm>()
+                    .NoProxy()
+                    .DefaultCommands()
+                    .NoSerialization()
+                    .UsePersian()
+                    .Build();
+
+        return bot;
+    }
+}

TelegramBotBase/Builder/BotBaseBuilder.cs

@@ -140,6 +140,12 @@ public IStartFormSelectionStage DefaultMessageLoop()
         return this;
     }
 
+    public IStartFormSelectionStage MiddlewareMessageLoop(Func<MiddlewareBaseMessageLoop, MiddlewareBaseMessageLoop> messageLoopConfiguration)
+    {
+        _messageLoopFactory = messageLoopConfiguration(new MiddlewareBaseMessageLoop());
+
+        return this;
+    }
 
     public IStartFormSelectionStage MinimalMessageLoop()
     {

TelegramBotBase/Builder/Interfaces/IMessageLoopSelectionStage.cs

@@ -1,4 +1,6 @@
-using TelegramBotBase.Interfaces;
+using System;
+using TelegramBotBase.Interfaces;
+using TelegramBotBase.MessageLoops;
 
 namespace TelegramBotBase.Builder.Interfaces;
 
@@ -12,6 +14,12 @@ public interface IMessageLoopSelectionStage
     IStartFormSelectionStage DefaultMessageLoop();
 
 
+    /// <summary>
+    ///     Choses a fully customizable middleware-based message loop.
+    /// </summary>
+    IStartFormSelectionStage MiddlewareMessageLoop(Func<MiddlewareBaseMessageLoop, MiddlewareBaseMessageLoop> messageLoopConfiguration);
+
+
     /// <summary>
     ///     Chooses a minimalistic message loop, which catches all update types and only calls the Load function.
     /// </summary>

TelegramBotBase/Localizations/Persian.cs

@@ -1,37 +1,36 @@
-namespace TelegramBotBase.Localizations
+namespace TelegramBotBase.Localizations;
+
+public sealed class Persian : Localization
 {
-    public sealed class Persian : Localization
+    public Persian()
     {
-        public Persian()
-        {
-            Values["Language"] = "فارسی";
-            Values["ButtonGrid_Title"] = "منو";
-            Values["ButtonGrid_NoItems"] = "هیچ آیتمی وجود ندارد.";
-            Values["ButtonGrid_PreviousPage"] = "◀️";
-            Values["ButtonGrid_NextPage"] = "▶️";
-            Values["ButtonGrid_CurrentPage"] = "صفحه ی {0} از {1}";
-            Values["ButtonGrid_SearchFeature"] = "💡 برای فیلتر کردن لیست پیام ارسال کنید. برای بازنشانی فیلتر روی 🔍 کلیک کنید.";
-            Values["ButtonGrid_Back"] = "بازگشت";
-            Values["ButtonGrid_CheckAll"] = "بررسی کردن همه";
-            Values["ButtonGrid_UncheckAll"] = "بررسی نکردن همه";
-            Values["CalendarPicker_Title"] = "تاریخ را انتخاب کنید";
-            Values["CalendarPicker_PreviousPage"] = "◀️";
-            Values["CalendarPicker_NextPage"] = "▶️";
-            Values["TreeView_Title"] = "گره را انتخاب کنید";
-            Values["TreeView_LevelUp"] = "🔼 سطح بالا";
-            Values["ToggleButton_On"] = "روشن";
-            Values["ToggleButton_Off"] = "خاموش";
-            Values["ToggleButton_OnIcon"] = "⚫";
-            Values["ToggleButton_OffIcon"] = "⚪";
-            Values["ToggleButton_Title"] = "تغییر وضعیت";
-            Values["ToggleButton_Changed"] = "انتخاب شده";
-            Values["MultiToggleButton_SelectedIcon"] = "✅";
-            Values["MultiToggleButton_Title"] = "چند تعویض";
-            Values["MultiToggleButton_Changed"] = "انتخاب شده";
-            Values["PromptDialog_Back"] = "بازگشت";
-            Values["ToggleButton_Changed"] = "تنظیمات تغییر کرد";
-            Values["ButtonGrid_SearchIcon"] = "🔍";
-            Values["ButtonGrid_TagIcon"] = "📁";
-        }
+        Values["Language"] = "فارسی";
+        Values["ButtonGrid_Title"] = "منو";
+        Values["ButtonGrid_NoItems"] = "هیچ آیتمی وجود ندارد.";
+        Values["ButtonGrid_PreviousPage"] = "◀️";
+        Values["ButtonGrid_NextPage"] = "▶️";
+        Values["ButtonGrid_CurrentPage"] = "صفحه ی {0} از {1}";
+        Values["ButtonGrid_SearchFeature"] = "💡 برای فیلتر کردن لیست پیام ارسال کنید. برای بازنشانی فیلتر روی 🔍 کلیک کنید.";
+        Values["ButtonGrid_Back"] = "بازگشت";
+        Values["ButtonGrid_CheckAll"] = "بررسی کردن همه";
+        Values["ButtonGrid_UncheckAll"] = "بررسی نکردن همه";
+        Values["CalendarPicker_Title"] = "تاریخ را انتخاب کنید";
+        Values["CalendarPicker_PreviousPage"] = "◀️";
+        Values["CalendarPicker_NextPage"] = "▶️";
+        Values["TreeView_Title"] = "گره را انتخاب کنید";
+        Values["TreeView_LevelUp"] = "🔼 سطح بالا";
+        Values["ToggleButton_On"] = "روشن";
+        Values["ToggleButton_Off"] = "خاموش";
+        Values["ToggleButton_OnIcon"] = "⚫";
+        Values["ToggleButton_OffIcon"] = "⚪";
+        Values["ToggleButton_Title"] = "تغییر وضعیت";
+        Values["ToggleButton_Changed"] = "انتخاب شده";
+        Values["MultiToggleButton_SelectedIcon"] = "✅";
+        Values["MultiToggleButton_Title"] = "چند تعویض";
+        Values["MultiToggleButton_Changed"] = "انتخاب شده";
+        Values["PromptDialog_Back"] = "بازگشت";
+        Values["ToggleButton_Changed"] = "تنظیمات تغییر کرد";
+        Values["ButtonGrid_SearchIcon"] = "🔍";
+        Values["ButtonGrid_TagIcon"] = "📁";
     }
 }