Preparing BlazorToolkit to be moved into the separate repo

yfranz · yfranz · commit be666d918a9d · 2024-11-25T16:51:54.000-08:00
diff --git a/DevInstance.DevCoreApp.sln b/DevInstance.DevCoreApp.sln
@@ -33,7 +33,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EmailProcessor.MailKit", "s
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EmailProcessor", "src\Server\Email\Processor\EmailProcessor.csproj", "{7609E010-1A0A-4181-A840-84C6723EC47F}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DevInstance.BlazorUtils", "src\Client\DevInstance.BlazorUtils\DevInstance.BlazorUtils.csproj", "{3724BE39-FBF4-4657-9929-DAFC35A2E3B1}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DevInstance.BlazorToolkit", "src\Client\DevInstance.BlazorUtils\DevInstance.BlazorToolkit.csproj", "{3724BE39-FBF4-4657-9929-DAFC35A2E3B1}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Shared.Services", "src\Shared\Services\Shared.Services.csproj", "{92C1A160-4F63-4B6A-897E-2088EEC67F7A}"
 EndProject
diff --git a/src/Client/Client.Services/CRUDService.cs b/src/Client/Client.Services/CRUDService.cs
@@ -1,8 +1,8 @@
 ﻿using DevInstance.DevCoreApp.Shared.Model;
-using DevInstance.BlazorUtils.Http;
-using DevInstance.BlazorUtils.Services;
+using DevInstance.BlazorToolkit.Http;
+using DevInstance.BlazorToolkit.Services;
 using DevInstance.DevCoreApp.Shared.Services;
-using DevInstance.BlazorUtils.Services.Wasm;
+using DevInstance.BlazorToolkit.Services.Wasm;
 using DevInstance.LogScope;
 
 namespace DevInstance.DevCoreApp.Client.Services;
diff --git a/src/Client/Client.Services/Client.Services.csproj b/src/Client/Client.Services/Client.Services.csproj
@@ -21,7 +21,7 @@
 	  <ProjectReference Include="..\..\Shared\Model\Shared.Model.csproj" />
 	  <ProjectReference Include="..\..\Shared\Services\Shared.Services.csproj" />
 	  <ProjectReference Include="..\..\Shared\Utils\Shared.Utils.csproj" />
-	  <ProjectReference Include="..\DevInstance.BlazorUtils\DevInstance.BlazorUtils.csproj" />
+	  <ProjectReference Include="..\DevInstance.BlazorUtils\DevInstance.BlazorToolkit.csproj" />
 	</ItemGroup>
 
 </Project>
diff --git a/src/Client/Client.Services/Net/Api/INetApiRepository.cs.cs b/src/Client/Client.Services/Net/Api/INetApiRepository.cs.cs
@@ -1,5 +1,5 @@
 ﻿using DevInstance.DevCoreApp.Shared.Model;
-using DevInstance.BlazorUtils.Http;
+using DevInstance.BlazorToolkit.Http;
 using System;
 using System.Collections.Generic;
 using System.Linq;
diff --git a/src/Client/Client.Services/Net/NetApiRepository.cs b/src/Client/Client.Services/Net/NetApiRepository.cs
@@ -1,5 +1,5 @@
 ﻿using DevInstance.DevCoreApp.Shared.Model;
-using DevInstance.BlazorUtils.Http;
+using DevInstance.BlazorToolkit.Http;
 using Microsoft.AspNetCore.Components;
 using DevInstance.DevCoreApp.Client.Services.Net.Api;
 using System.Net.Http;
diff --git a/src/Client/Client.Services/SettingsService.cs b/src/Client/Client.Services/SettingsService.cs
@@ -1,7 +1,7 @@
 ﻿using Microsoft.Extensions.Localization;
 using System.Globalization;
 using DevInstance.DevCoreApp.Shared.Services;
-using DevInstance.BlazorUtils.Services.Wasm;
+using DevInstance.BlazorToolkit.Services.Wasm;
 
 namespace DevInstance.DevCoreApp.Client.Services;
 
diff --git a/src/Client/Client.Services/WeatherForecastService.cs b/src/Client/Client.Services/WeatherForecastService.cs
@@ -1,9 +1,9 @@
 ﻿using DevInstance.DevCoreApp.Shared.Model;
-using DevInstance.BlazorUtils.Services;
+using DevInstance.BlazorToolkit.Services;
 using DevInstance.LogScope;
 using DevInstance.DevCoreApp.Client.Services.Net.Api;
 using DevInstance.DevCoreApp.Shared.Services;
-using DevInstance.BlazorUtils.Services.Wasm;
+using DevInstance.BlazorToolkit.Services.Wasm;
 
 namespace DevInstance.DevCoreApp.Client.Services;
 
diff --git a/src/Client/DevCoreApp.Client/UI/Components/BasePage.cs b/src/Client/DevCoreApp.Client/UI/Components/BasePage.cs
@@ -1,4 +1,4 @@
-﻿using DevInstance.BlazorUtils.Services;
+﻿using DevInstance.BlazorToolkit.Services;
 using DevInstance.LogScope;
 using Microsoft.AspNetCore.Components;
 
@@ -19,8 +19,17 @@ protected override void OnInitialized()
         log = ScopeManager.CreateLogger(this);
     }
 
+    /// <summary>
+    /// Flag to indicate if the service call is in progress
+    /// </summary>
     public bool InProgress { get; set; } = false;
+    /// <summary>
+    /// Flag to indicate if the service call has an error
+    /// </summary>
     public bool IsError { get; set; } = false;
+    /// <summary>
+    /// Error message from the service call
+    /// </summary>
     public string ErrorMessage { get; set; } = "";
 
     protected ServiceExecutionHandler BeginServiceCall()
diff --git a/src/Client/DevInstance.BlazorUtils/DevInstance.BlazorToolkit.csproj b/src/Client/DevInstance.BlazorUtils/DevInstance.BlazorToolkit.csproj
@@ -4,9 +4,10 @@
 		<TargetFramework>net8.0</TargetFramework>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
-		<AssemblyName>DevInstance.BlazorUtils</AssemblyName>
-		<RootNamespace>DevInstance.BlazorUtils</RootNamespace>
+		<AssemblyName>DevInstance.BlazorToolkit</AssemblyName>
+		<RootNamespace>DevInstance.BlazorToolkit</RootNamespace>
 		<Configurations>Debug;Release;NetApiMoqs;ServiceMoqs</Configurations>
+		<Copyright>Copyright 2021-2024 DevInstance LLC</Copyright>
 	</PropertyGroup>
 
 	<ItemGroup>
diff --git a/src/Client/DevInstance.BlazorUtils/Http/ApiUrlBuilder.cs b/src/Client/DevInstance.BlazorUtils/Http/ApiUrlBuilder.cs
@@ -1,6 +1,6 @@
 ﻿using System.Text;
 
-namespace DevInstance.BlazorUtils.Http;
+namespace DevInstance.BlazorToolkit.Http;
 
 public class ApiUrlBuilder
 {
diff --git a/src/Client/DevInstance.BlazorUtils/Http/HttpApiContext.cs b/src/Client/DevInstance.BlazorUtils/Http/HttpApiContext.cs
@@ -1,7 +1,7 @@
 ﻿using DevInstance.DevCoreApp.Shared.Model;
 using System.Net.Http.Json;
 
-namespace DevInstance.BlazorUtils.Http;
+namespace DevInstance.BlazorToolkit.Http;
 
 internal class HttpApiContext<T> : IApiContext<T>
 {
diff --git a/src/Client/DevInstance.BlazorUtils/Http/HttpApiContextFactory.cs b/src/Client/DevInstance.BlazorUtils/Http/HttpApiContextFactory.cs
@@ -1,4 +1,4 @@
-﻿namespace DevInstance.BlazorUtils.Http;
+﻿namespace DevInstance.BlazorToolkit.Http;
 
 public class HttpApiContextFactory
 {
diff --git a/src/Client/DevInstance.BlazorUtils/Http/IApiContext.cs b/src/Client/DevInstance.BlazorUtils/Http/IApiContext.cs
@@ -1,6 +1,6 @@
 ﻿using DevInstance.DevCoreApp.Shared.Model;
 
-namespace DevInstance.BlazorUtils.Http;
+namespace DevInstance.BlazorToolkit.Http;
 
 public interface IApiContext<T>
 {
diff --git a/src/Client/DevInstance.BlazorUtils/Services/IServiceExecutionHost.cs b/src/Client/DevInstance.BlazorUtils/Services/IServiceExecutionHost.cs
@@ -1,11 +1,31 @@
-﻿namespace DevInstance.BlazorUtils.Services;
+﻿namespace DevInstance.BlazorToolkit.Services;
 
+/// <summary>
+/// Interface for the service execution host. This should be 
+/// implemented by the component to handle the service call 
+/// status and errors.
+/// </summary>
 public interface IServiceExecutionHost
 {
+    /// <summary>
+    /// Error message from the service call (when IsError is true)
+    /// </summary>
     string ErrorMessage { get; set; }
+    /// <summary>
+    /// Flag to indicate if the service call has an error
+    /// </summary>
     bool IsError { get; set; }
+    /// <summary>
+    /// Flag to indicate if the service call is in progress
+    /// </summary>
     bool InProgress { get; set; }
 
+    /// <summary>
+    /// The implementation of this method should navigate to the login page
+    /// </summary>
     void ShowLogin();
+    /// <summary>
+    /// The implementation of this method should call the StateHasChanged method to re-render the page
+    /// </summary>
     void StateHasChanged();
 }
diff --git a/src/Client/DevInstance.BlazorUtils/Services/Server/ServiceUtils.cs b/src/Client/DevInstance.BlazorUtils/Services/Server/ServiceUtils.cs
@@ -1,6 +1,6 @@
 ﻿using DevInstance.LogScope;
 
-namespace DevInstance.BlazorUtils.Services.Server
+namespace DevInstance.BlazorToolkit.Services.Server
 {
     public static class ServiceUtils
     {
diff --git a/src/Client/DevInstance.BlazorUtils/Services/ServiceActionError.cs b/src/Client/DevInstance.BlazorUtils/Services/ServiceActionError.cs
@@ -1,4 +1,4 @@
-﻿namespace DevInstance.BlazorUtils.Services;
+﻿namespace DevInstance.BlazorToolkit.Services;
 
 public class ServiceActionError
 {
diff --git a/src/Client/DevInstance.BlazorUtils/Services/ServiceActionResult.cs b/src/Client/DevInstance.BlazorUtils/Services/ServiceActionResult.cs
@@ -1,5 +1,9 @@
-﻿namespace DevInstance.BlazorUtils.Services;
+﻿namespace DevInstance.BlazorToolkit.Services;
 
+/// <summary>
+/// Class to hold the result of the service action
+/// </summary>
+/// <typeparam name="T"></typeparam>
 public class ServiceActionResult<T>
 {
     public T? Result { get; set; }
diff --git a/src/Client/DevInstance.BlazorUtils/Services/ServiceExecutionHandler.cs b/src/Client/DevInstance.BlazorUtils/Services/ServiceExecutionHandler.cs
@@ -1,6 +1,6 @@
 ﻿using DevInstance.LogScope;
 
-namespace DevInstance.BlazorUtils.Services;
+namespace DevInstance.BlazorToolkit.Services;
 
 public delegate Task<ServiceActionResult<T>> PerformAsyncCallHandler<T>();
 
diff --git a/src/Client/DevInstance.BlazorUtils/Services/Wasm/ServiceUtils.cs b/src/Client/DevInstance.BlazorUtils/Services/Wasm/ServiceUtils.cs
@@ -1,7 +1,7 @@
 ﻿using DevInstance.LogScope;
 using System.Net;
 
-namespace DevInstance.BlazorUtils.Services.Wasm;
+namespace DevInstance.BlazorToolkit.Services.Wasm;
 
 public delegate void ResultHandler<T>(T result);
 
diff --git a/src/Server/WebService/Services/WeatherForecastService.cs b/src/Server/WebService/Services/WeatherForecastService.cs
@@ -1,5 +1,5 @@
-﻿using DevInstance.BlazorUtils.Services;
-using DevInstance.BlazorUtils.Services.Server;
+﻿using DevInstance.BlazorToolkit.Services;
+using DevInstance.BlazorToolkit.Services.Server;
 using DevInstance.DevCoreApp.Server.Database.Core.Data;
 using DevInstance.DevCoreApp.Server.Database.Core.Data.Decorators;
 using DevInstance.DevCoreApp.Server.Database.Core.Models;
@@ -118,22 +118,22 @@ public async Task<WeatherForecastItem> UpdateAsync(string id, WeatherForecastIte
         return await GetByIdAsync(record.PublicId);
     }
 
-    public Task<BlazorUtils.Services.ServiceActionResult<WeatherForecastItem?>> GetAsync(string id)
+    public Task<BlazorToolkit.Services.ServiceActionResult<WeatherForecastItem?>> GetAsync(string id)
     {
         throw new NotImplementedException();
     }
 
-    public Task<BlazorUtils.Services.ServiceActionResult<WeatherForecastItem?>> AddNewAsync(WeatherForecastItem item)
+    public Task<BlazorToolkit.Services.ServiceActionResult<WeatherForecastItem?>> AddNewAsync(WeatherForecastItem item)
     {
         throw new NotImplementedException();
     }
 
-    public Task<BlazorUtils.Services.ServiceActionResult<WeatherForecastItem?>> UpdateAsync(WeatherForecastItem item)
+    public Task<BlazorToolkit.Services.ServiceActionResult<WeatherForecastItem?>> UpdateAsync(WeatherForecastItem item)
     {
         throw new NotImplementedException();
     }
 
-    public Task<BlazorUtils.Services.ServiceActionResult<bool>> RemoveAsync(WeatherForecastItem item)
+    public Task<BlazorToolkit.Services.ServiceActionResult<bool>> RemoveAsync(WeatherForecastItem item)
     {
         throw new NotImplementedException();
     }
diff --git a/src/Shared/Services/ICRUDService.cs b/src/Shared/Services/ICRUDService.cs
@@ -1,5 +1,5 @@
 ﻿using DevInstance.DevCoreApp.Shared.Model;
-using DevInstance.BlazorUtils.Services;
+using DevInstance.BlazorToolkit.Services;
 
 namespace DevInstance.DevCoreApp.Shared.Services;
 
diff --git a/src/Shared/Services/IWeatherForecastService.cs b/src/Shared/Services/IWeatherForecastService.cs
@@ -1,5 +1,5 @@
 ﻿
-using DevInstance.BlazorUtils.Services;
+using DevInstance.BlazorToolkit.Services;
 using DevInstance.DevCoreApp.Shared.Model;
 
 namespace DevInstance.DevCoreApp.Shared.Services;
diff --git a/src/Shared/Services/Shared.Services.csproj b/src/Shared/Services/Shared.Services.csproj
@@ -14,7 +14,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<ProjectReference Include="..\..\Client\DevInstance.BlazorUtils\DevInstance.BlazorUtils.csproj" />
+		<ProjectReference Include="..\..\Client\DevInstance.BlazorUtils\DevInstance.BlazorToolkit.csproj" />
 	</ItemGroup>
 
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`using System.Text;`
`2`	`2`
`3`		`-namespace DevInstance.BlazorUtils.Http;`
	`3`	`+namespace DevInstance.BlazorToolkit.Http;`
`4`	`4`
`5`	`5`	`public class ApiUrlBuilder`
`6`	`6`	`{`