Merge pull request #12 from navigatorframework/feature/improve-develo…

…per-experience

feature: improve developer experience

src/Navigator.Extensions.Store/Context/NavigatorDbContext.cs

@@ -20,9 +20,24 @@ public NavigatorDbContext(DbContextOptions<NavigatorDbContext> options) : base(o
     {
     }
 
+    /// <summary>
+    /// Bots.
+    /// </summary>
     public required DbSet<Bot> Bots { get; set; }
+
+    /// <summary>
+    /// Users.
+    /// </summary>
     public required DbSet<User> Users { get; set; }
+
+    /// <summary>
+    /// Chats.
+    /// </summary>
     public required DbSet<Chat> Chats { get; set; }
+
+    /// <summary>
+    /// Conversations.
+    /// </summary>
     public required DbSet<Conversation> Conversations { get; set; }
 
     /// <inheritdoc />

src/Navigator.Extensions.Store/Entities/Chat.cs

@@ -1,3 +1,5 @@
+using Navigator.Entities;
+
 namespace Navigator.Extensions.Store.Entities;
 
 /// <summary>
@@ -32,10 +34,30 @@ public Chat(Navigator.Entities.Chat chat)
     }
 
 
+    /// <summary>
+    /// Id of the chat.
+    /// </summary>
     public long Id { get; set; }
 
+    /// <summary>
+    /// Title of the chat.
+    /// <remarks>
+    ///     Optional.
+    /// </remarks>
+    /// </summary>
     public string? Title { get; set; }
+
+    /// <summary>
+    /// Type of the chat, can be any of <see cref="Navigator.Entities.Chat.ChatType"/>.
+    /// </summary>
     public Navigator.Entities.Chat.ChatType Type { get; set; }
+
+    /// <summary>
+    /// If the supergroup chat is a forum (has topics enabled).
+    /// <remarks>
+    ///     Optional.
+    /// </remarks>
+    /// </summary>
     public bool? IsForum { get; set; }
 
     /// <summary>

src/Navigator.Extensions.Store/Entities/Conversation.cs

@@ -1,5 +1,8 @@
 namespace Navigator.Extensions.Store.Entities;
 
+/// <summary>
+/// Conversation.
+/// </summary>
 public class Conversation
 {
     /// <summary>
@@ -21,13 +24,19 @@ public Conversation(User user, Chat chat)
         FirstInteractionAt = DateTime.UtcNow;
     }
 
+    /// <summary>
+    /// Id of the user.
+    /// </summary>
     public long UserId { get; set; }
 
     /// <summary>
     /// User.
     /// </summary>
     public User User { get; set; } = null!;
 
+    /// <summary>
+    /// Id of the chat.
+    /// </summary>
     public long ChatId { get; set; }
 
     /// <summary>

src/Navigator.Extensions.Store/NavigatorContextExtensions.cs

@@ -1,10 +1,11 @@
 using Navigator.Context;
-using Navigator.Extensions.Bundled.OriginalEvent;
 using Navigator.Extensions.Store.Context;
-using Telegram.Bot.Types;
 
 namespace Navigator.Extensions.Store;
 
+/// <summary>
+/// Extensions for <see cref="NavigatorContext"/>.
+/// </summary>
 public static class NavigatorContextExtensions
 {
     #region NavigatorStore

src/Navigator.Extensions.Store/NavigatorStoreException.cs

@@ -2,20 +2,27 @@
 
 namespace Navigator.Extensions.Store;
 
+/// <summary>
+/// Navigator Store exception.
+/// </summary>
 public class NavigatorStoreException : NavigatorException
 {
+    /// <inheritdoc />
     public NavigatorStoreException()
     {
     }
 
+    /// <inheritdoc />
     protected NavigatorStoreException(SerializationInfo info, StreamingContext context) : base(info, context)
     {
     }
 
+    /// <inheritdoc />
     public NavigatorStoreException(string? message) : base(message)
     {
     }
 
+    /// <inheritdoc />
     public NavigatorStoreException(string? message, Exception? innerException) : base(message, innerException)
     {
     }

src/Navigator/Actions/ActionHandler.cs

@@ -4,24 +4,49 @@
 
 namespace Navigator.Actions;
 
+/// <summary>
+/// Implement to handle an action.
+/// </summary>
+/// <typeparam name="TAction"></typeparam>
 public abstract class ActionHandler<TAction> : IRequestHandler<TAction, Status> where TAction : IAction
 {
+    /// <summary>
+    /// Context for the action.
+    /// </summary>
     public readonly INavigatorContext Context;
 
+    /// <summary>
+    /// Default constructor.
+    /// </summary>
+    /// <param name="navigatorContextAccessor"></param>
     protected ActionHandler(INavigatorContextAccessor navigatorContextAccessor)
     {
         Context = navigatorContextAccessor.NavigatorContext;
     }
 
+    /// <summary>
+    /// Handles the action.
+    /// </summary>
+    /// <param name="action"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns><see cref="Status"/></returns>
     public abstract Task<Status> Handle(TAction action, CancellationToken cancellationToken);
 
-    public static Status Success()
+    /// <summary>
+    /// Called when the action was handled successfully.
+    /// </summary>
+    /// <returns><see cref="Status"/></returns>
+    protected static Status Success()
     {
-        return new(true);
+        return new Status(true);
     }
 
-    public static Status Error()
+    /// <summary>
+    /// Called when the action was not handled successfully.
+    /// </summary>
+    /// <returns><see cref="Status"/></returns>
+    protected static Status Error()
     {
-        return new(false);
+        return new Status(false);
     }
 }

src/Navigator/Actions/Attributes/ActionPriorityAttribute.cs

@@ -6,8 +6,15 @@ namespace Navigator.Actions.Attributes;
 [System.AttributeUsage(System.AttributeTargets.Class)]
 public class ActionPriorityAttribute : System.Attribute
 {
+    /// <summary>
+    /// Priority.
+    /// </summary>
     public readonly ushort Priority;
 
+    /// <summary>
+    /// Sets the action priority.
+    /// </summary>
+    /// <param name="priority"></param>
     public ActionPriorityAttribute(ushort priority)
     {
         Priority = priority;

src/Navigator/Actions/Attributes/ActionTypeAttribute.cs

@@ -1,10 +1,20 @@
 namespace Navigator.Actions.Attributes;
 
+/// <summary>
+/// Attribute for setting the action type.
+/// </summary>
 [System.AttributeUsage(System.AttributeTargets.Class)]
 public class ActionTypeAttribute : System.Attribute
 {
-    public string ActionType;
+    /// <summary>
+    /// Action type.
+    /// </summary>
+    public readonly string ActionType;
 
+    /// <summary>
+    /// Sets the action type.
+    /// </summary>
+    /// <param name="action"></param>
     public ActionTypeAttribute(string action)
     {
         ActionType = action;

src/Navigator/Actions/BaseAction.cs

@@ -17,6 +17,9 @@ public abstract class BaseAction : IAction
     /// </summary>
     protected INavigatorContext Context => _navigatorContextAccessor.NavigatorContext;
 
+    /// <summary>
+    /// Priority of the request.
+    /// </summary>
     public virtual ushort Priority { get; protected set; } = Actions.Priority.Default;
 
     /// <summary>

src/Navigator/Actions/IActionLauncher.cs

@@ -1,6 +1,13 @@
 namespace Navigator.Actions;
 
+/// <summary>
+/// Action launcher interface.
+/// </summary>
 public interface IActionLauncher
 {
+    /// <summary>
+    /// Launches one or more actions.
+    /// </summary>
+    /// <returns></returns>
     Task Launch();
 }

src/Navigator/Actions/IActionMiddleware.cs

@@ -3,7 +3,7 @@
 namespace Navigator.Actions;
 
 /// <summary>
-/// TODO
+/// Interface to implement middleware for actions.
 /// </summary>
 /// <typeparam name="TAction"></typeparam>
 /// <typeparam name="TResponse"></typeparam>

src/Navigator/Actions/NavigatorOptionsExtensions.cs

@@ -4,6 +4,9 @@
 
 namespace Navigator.Actions;
 
+/// <summary>
+/// Extensions for <see cref="NavigatorOptions"/>.
+/// </summary>
 public static class NavigatorOptionsExtensions
 {
     #region NavigatorActionTypeCollection

src/Navigator/Actions/Priority.cs

@@ -1,8 +1,22 @@
 namespace Navigator.Actions;
 
+/// <summary>
+/// Priority presets.
+/// </summary>
 public static class Priority
 {
+    /// <summary>
+    /// Low priority.
+    /// </summary>
     public const ushort Low = 15000;
+
+    /// <summary>
+    /// Default priority
+    /// </summary>
     public const ushort Default = 10000;
+
+    /// <summary>
+    /// High priority.
+    /// </summary>
     public const ushort High = 5000;
 }

src/Navigator/Actions/Status.cs

@@ -1,12 +1,26 @@
 namespace Navigator.Actions;
 
-public struct Status
+/// <summary>
+/// Represents the outcome of an action.
+/// </summary>
+public readonly struct Status
 {
     private readonly bool _isSuccess;
 
+    /// <summary>
+    /// Is success.
+    /// </summary>
     public bool IsSuccess => _isSuccess;
+
+    /// <summary>
+    /// Is error.
+    /// </summary>
     public bool IsError => !_isSuccess;
 
+    /// <summary>
+    /// Default constructor.
+    /// </summary>
+    /// <param name="isSuccess"></param>
     public Status(bool isSuccess)
     {
         _isSuccess = isSuccess;

src/Navigator/Bundled/Actions/Bundled/CommandAction.cs → src/Navigator/Bundled/Actions/CommandAction.cs

@@ -3,7 +3,7 @@
 using Navigator.Context.Accessor;
 using Navigator.Telegram;
 
-namespace Navigator.Bundled.Actions.Bundled;
+namespace Navigator.Bundled.Actions;
 
 /// <summary>
 /// Command based action.

src/Navigator/Bundled/Actions/Messages/MessageAction.cs

@@ -1,7 +1,7 @@
 using Navigator.Actions;
 using Navigator.Actions.Attributes;
+using Navigator.Bundled.Extensions.Update;
 using Navigator.Context.Accessor;
-using Navigator.Extensions.Bundled;
 using Telegram.Bot.Types;
 
 namespace Navigator.Bundled.Actions.Messages;
@@ -25,7 +25,7 @@ public abstract class MessageAction : BaseAction
     /// <summary>
     /// Timestamp of the message creation.
     /// </summary>
-    public readonly DateTime Timestamp;
+    public new readonly DateTime Timestamp;
 
     /// <summary>
     /// Determines if this message is a reply to another message.
@@ -40,7 +40,7 @@ public abstract class MessageAction : BaseAction
     /// <inheritdoc />
     protected MessageAction(INavigatorContextAccessor navigatorContextAccessor) : base(navigatorContextAccessor)
     {
-        var update = navigatorContextAccessor.NavigatorContext.GetOriginalEvent();
+        var update = navigatorContextAccessor.NavigatorContext.GetUpdate();
 
         Message = update.Message!;
         ChatId = Context.Conversation.Chat!.Id;

src/Navigator/Bundled/Actions/Messages/PhotoAction.cs

@@ -1,5 +1,4 @@
 using Navigator.Actions.Attributes;
-using Navigator.Bundled.Actions.Bundled;
 using Navigator.Context.Accessor;
 using Navigator.Telegram;
 using Telegram.Bot.Types;

src/Navigator/Bundled/Actions/Messages/TextAction.cs

@@ -1,5 +1,4 @@
 using Navigator.Actions.Attributes;
-using Navigator.Bundled.Actions.Bundled;
 using Navigator.Context.Accessor;
 using Navigator.Telegram;