Added comments

Author: giovanninocco

README.md

@@ -9,7 +9,7 @@
 
 
 ---
-This repo contains a set of libraries designed by Genocs. The libraries are built using .NET standard 2.1 or .NET7. 
+This repo contains a set of libraries designed by Genocs. The libraries are built using .NET standard 2.1, .NET6 and .NET7. 
 
 Packages are available on [NuGet Genocs](https://www.nuget.org/profiles/gioema_nocco).
 

src/Genocs.Auth/AccessTokenValidatorMiddleware.cs

@@ -3,17 +3,32 @@
 
 namespace Genocs.Auth;
 
+
+/// <summary>
+/// The access token validator middleware
+/// </summary>
 public class AccessTokenValidatorMiddleware : IMiddleware
 {
     private readonly IAccessTokenService _accessTokenService;
     private readonly IEnumerable<string> _endpoints;
 
+    /// <summary>
+    /// The AccessTokenValidatorMiddleware constructor
+    /// </summary>
+    /// <param name="accessTokenService">The access token service</param>
+    /// <param name="options">The options</param>
     public AccessTokenValidatorMiddleware(IAccessTokenService accessTokenService, JwtOptions options)
     {
         _accessTokenService = accessTokenService;
         _endpoints = options.AllowAnonymousEndpoints ?? Enumerable.Empty<string>();
     }
 
+    /// <summary>
+    /// The InvokeAsync method
+    /// </summary>
+    /// <param name="context">The http context</param>
+    /// <param name="next">The request delegate</param>
+    /// <returns></returns>
     public async Task InvokeAsync(HttpContext context, RequestDelegate next)
     {
         var path = context.Request.Path.HasValue ? context.Request.Path.Value : string.Empty;

src/Genocs.Auth/AuthAttribute.cs

@@ -10,8 +10,8 @@ public class AuthAttribute : AuthorizeAttribute
     /// <summary>
     /// The AuthAttribute constructor
     /// </summary>
-    /// <param name="scheme"></param>
-    /// <param name="policy"></param>
+    /// <param name="scheme">The authorization schema</param>
+    /// <param name="policy">The authorization policy</param>
     public AuthAttribute(string scheme, string policy = "") : base(policy)
     {
         AuthenticationSchemes = scheme;

src/Genocs.Auth/DisabledAuthenticationPolicyEvaluator.cs

@@ -9,13 +9,27 @@ namespace Genocs.Auth;
 
 internal sealed class DisabledAuthenticationPolicyEvaluator : IPolicyEvaluator
 {
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="policy"></param>
+    /// <param name="context"></param>
+    /// <returns></returns>
     public Task<AuthenticateResult> AuthenticateAsync(AuthorizationPolicy policy, HttpContext context)
     {
         var authenticationTicket = new AuthenticationTicket(new ClaimsPrincipal(),
             new AuthenticationProperties(), JwtBearerDefaults.AuthenticationScheme);
         return Task.FromResult(AuthenticateResult.Success(authenticationTicket));
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="policy"></param>
+    /// <param name="authenticationResult"></param>
+    /// <param name="context"></param>
+    /// <param name="resource"></param>
+    /// <returns></returns>
     public Task<PolicyAuthorizationResult> AuthorizeAsync(AuthorizationPolicy policy,
         AuthenticateResult authenticationResult, HttpContext context, object resource)
     {

src/Genocs.Auth/Handlers/JwtHandler.cs

@@ -107,6 +107,11 @@ public JsonWebToken CreateToken(string userId,
         };
     }
 
+    /// <summary>
+    /// Gets the token payload.
+    /// </summary>
+    /// <param name="accessToken"></param>
+    /// <returns></returns>
     public JsonWebTokenPayload? GetTokenPayload(string accessToken)
     {
         _jwtSecurityTokenHandler.ValidateToken(accessToken, _tokenValidationParameters,

src/Genocs.Auth/IJwtHandler.cs

@@ -23,5 +23,5 @@ JsonWebToken CreateToken(string userId,
     /// </summary>
     /// <param name="accessToken">The access token string value</param>
     /// <returns>The JsonWebTokenPayload</returns>
-    JsonWebTokenPayload GetTokenPayload(string accessToken);
+    JsonWebTokenPayload? GetTokenPayload(string accessToken);
 }

src/Genocs.Auth/JsonWebToken.cs

@@ -1,11 +1,38 @@
 namespace Genocs.Auth;
 
+
+/// <summary>
+/// The JSON Web Token definition.
+/// </summary>
 public class JsonWebToken
 {
-    public string AccessToken { get; set; }
-    public string RefreshToken { get; set; }
+    /// <summary>
+    /// Gets or sets the access token.
+    /// </summary>
+    public string? AccessToken { get; set; }
+
+    /// <summary>
+    /// Gets or sets the refresh token.
+    /// </summary>
+    public string? RefreshToken { get; set; }
+    
+    /// <summary>
+    /// Gets or sets the access token expiration.
+    /// </summary>
     public long Expires { get; set; }
-    public string Id { get; set; }
-    public string Role { get; set; }
-    public IDictionary<string, IEnumerable<string>> Claims { get; set; }
+
+    /// <summary>
+    /// Gets or sets the access token unique identifier.
+    /// </summary>
+    public string? Id { get; set; }
+
+    /// <summary>
+    /// Gets or sets the access token role.
+    /// </summary>
+    public string? Role { get; set; }
+
+    /// <summary>
+    /// The claims.
+    /// </summary>
+    public IDictionary<string, IEnumerable<string>>?  Claims { get; set; }
 }

src/Genocs.Auth/Services/InMemoryAccessTokenService.cs

@@ -45,7 +45,7 @@ private string GetCurrentAsync()
 
         if (authorizationHeader is null)
         {
-            return StringValues.Empty;
+            return string.Empty;
         }
 
         return authorizationHeader.Value == StringValues.Empty

src/Genocs.Core.Demo.Worker/Program.cs

@@ -38,7 +38,7 @@
 
         services
             .AddGenocs(hostContext.Configuration)
-            .AddMongoFast() // It adds the MongoDb Repository to the project and register all the Domain Objects with the standard interface
+            .AddMongoFast()
             .RegisterMongoRepositories(Assembly.GetExecutingAssembly()); // It registers the repositories that has been overridden. No need in case of standard repository
 
         ConfigureMassTransit(services, hostContext.Configuration);

src/Genocs.Core/CQRS/Queries/PagedResult.cs

@@ -33,8 +33,10 @@ protected PagedResult()
         /// <param name="totalResults"></param>
         [JsonConstructor]
         protected PagedResult(IEnumerable<T> items,
-            int currentPage, int resultsPerPage,
-            int totalPages, long totalResults) :
+                              int currentPage,
+                              int resultsPerPage,
+                              int totalPages,
+                              long totalResults) :
                 base(currentPage, resultsPerPage, totalPages, totalResults)
         {
             Items = items;