Flux v1.0

.editorconfig

@@ -7,4 +7,7 @@ dotnet_diagnostic.IDE0130.severity = none
 dotnet_diagnostic.BL0005.severity = none
 
 # BL0007: Component parameters should be auto properties
-dotnet_diagnostic.BL0007.severity = none
+dotnet_diagnostic.BL0007.severity = none
+
+# IDE0290: Use primary constructor
+dotnet_diagnostic.IDE0290.severity = none

.github/workflows/Publish Flux.yml

@@ -41,8 +41,12 @@ jobs:
       - name: Push
         run: |
           dotnet nuget push BitzArt.Flux.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_APIKEY}
-          dotnet nuget push BitzArt.Flux.REST.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_APIKEY}
+
           dotnet nuget push BitzArt.Flux.REST.Context.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_APIKEY}
+          dotnet nuget push BitzArt.Flux.REST.Builder.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_APIKEY}
+          dotnet nuget push BitzArt.Flux.REST.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_APIKEY}
+
           dotnet nuget push BitzArt.Flux.Json.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_APIKEY}
+
           dotnet nuget push BitzArt.Flux.MudBlazor.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_APIKEY}
 

BitzArt.Flux.sln

@@ -63,6 +63,45 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sln", "sln", "{9483F0E9-547
 		.editorconfig = .editorconfig
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{A2CF3320-C42E-44F5-B88A-2CC29EFB9460}"
+	ProjectSection(SolutionItems) = preProject
+		docs\book.toml = docs\book.toml
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{3122077F-A7F9-4212-97D9-868217EF9D1C}"
+	ProjectSection(SolutionItems) = preProject
+		docs\src\01.introduction.md = docs\src\01.introduction.md
+		docs\src\02.configure.md = docs\src\02.configure.md
+		docs\src\03.use.md = docs\src\03.use.md
+		docs\src\04.implementations.md = docs\src\04.implementations.md
+		docs\src\README.md = docs\src\README.md
+		docs\src\SUMMARY.md = docs\src\SUMMARY.md
+		docs\src\_config.yml = docs\src\_config.yml
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "json", "json", "{7B8D8836-126D-4F12-AF45-7D5414F58850}"
+	ProjectSection(SolutionItems) = preProject
+		docs\src\json\01.introduction.md = docs\src\json\01.introduction.md
+		docs\src\json\README.md = docs\src\json\README.md
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "rest", "rest", "{4E6BDC28-D997-43B7-B0DE-C676636669FE}"
+	ProjectSection(SolutionItems) = preProject
+		docs\src\rest\01.introduction.md = docs\src\rest\01.introduction.md
+		docs\src\rest\02.endpoints.md = docs\src\rest\02.endpoints.md
+		docs\src\rest\03.variables.md = docs\src\rest\03.variables.md
+		docs\src\rest\04.pagination.md = docs\src\rest\04.pagination.md
+		docs\src\rest\05.advanced.md = docs\src\rest\05.advanced.md
+		docs\src\rest\README.md = docs\src\rest\README.md
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "theme", "theme", "{D6F7155D-4BB7-4251-8C92-795F8A9F332D}"
+	ProjectSection(SolutionItems) = preProject
+		docs\theme\favicon.png = docs\theme\favicon.png
+	EndProjectSection
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BitzArt.Flux.REST.Builder", "src\REST\BitzArt.Flux.REST.Builder\BitzArt.Flux.REST.Builder.csproj", "{F040E34E-D8DD-421A-86A8-CE8D37007655}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -117,6 +156,10 @@ Global
 		{CBB67562-DEED-4E07-814A-EF6FCB3D5533}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{CBB67562-DEED-4E07-814A-EF6FCB3D5533}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{CBB67562-DEED-4E07-814A-EF6FCB3D5533}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F040E34E-D8DD-421A-86A8-CE8D37007655}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F040E34E-D8DD-421A-86A8-CE8D37007655}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F040E34E-D8DD-421A-86A8-CE8D37007655}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F040E34E-D8DD-421A-86A8-CE8D37007655}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -142,6 +185,11 @@ Global
 		{49160F37-A42B-4E08-A4F6-8C7D6F3AEE98} = {A3976FBB-F37A-4468-955D-8B2FCC79ACD0}
 		{F8192256-A717-4EA4-96CE-43196803AE03} = {A3976FBB-F37A-4468-955D-8B2FCC79ACD0}
 		{CBB67562-DEED-4E07-814A-EF6FCB3D5533} = {DF7F7802-31AB-4CDC-A177-9982951AF2DB}
+		{3122077F-A7F9-4212-97D9-868217EF9D1C} = {A2CF3320-C42E-44F5-B88A-2CC29EFB9460}
+		{7B8D8836-126D-4F12-AF45-7D5414F58850} = {3122077F-A7F9-4212-97D9-868217EF9D1C}
+		{4E6BDC28-D997-43B7-B0DE-C676636669FE} = {3122077F-A7F9-4212-97D9-868217EF9D1C}
+		{D6F7155D-4BB7-4251-8C92-795F8A9F332D} = {A2CF3320-C42E-44F5-B88A-2CC29EFB9460}
+		{F040E34E-D8DD-421A-86A8-CE8D37007655} = {DF7F7802-31AB-4CDC-A177-9982951AF2DB}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {251D5A13-6C1B-4B0D-A6F5-3B95FF4C0F54}

docs/src/SUMMARY.md

@@ -15,4 +15,5 @@
   - [Configuring endpoints](rest/02.endpoints.md)
   - [Custom Variables](rest/03.variables.md)
   - [Pagination](rest/04.pagination.md)
+  - [Advanced Scenarios](rest/05.advanced.md)
 - [Flux.JSON](json/01.introduction.md)

docs/src/rest/05.advanced.md

@@ -0,0 +1,27 @@
+## Advanced Scenarios
+
+### Custom HTTP Message Handlers
+
+**Flux.REST** allows configuring custom [http message handlers](https://learn.microsoft.com/en-us/aspnet/web-api/overview/advanced/http-message-handlers) for your external services. This can be useful for adding custom headers, logging, or any other custom logic.
+
+Example of an http message handler:
+
+```csharp
+private class MyHttpHandler : DelegatingHandler
+{
+    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+    {
+        return base.SendAsync(request, cancellationToken);
+    }
+}
+```
+
+To use a custom http message handler, add it when configuring your external service:
+
+```csharp
+services.AddFlux(flux =>
+{
+    flux.AddService("my-service")
+        .UsingRest<MyHttpHandler>("http://external.service.address")
+});
+```

docs/src/rest/README.md

@@ -15,4 +15,6 @@
    - [Methods](02.endpoints.md#methods)
 3. [Custom Variables](03.variables.md)
    - [Custom Page endpoint with parent id example](03.variables.md#custom-page-endpoint-with-parent-id-example)
-4. [Pagination](04.pagination.md)
+4. [Pagination](04.pagination.md)
+5. [Advanced Scenarios](05.advanced.md)
+   - [Custom HTTP Message Handlers](05.advanced.md#custom-http-message-handlers)

sample/MudBlazor/MudBlazor.SampleApp.Client/MudBlazor.SampleApp.Client.csproj

@@ -11,8 +11,8 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="9.*" />
-		<PackageReference Include="MudBlazor" Version="7.15.0" />
-		<PackageReference Include="System.Text.Json" Version="9.0.0" />
+		<PackageReference Include="MudBlazor" Version="8.2.0" />
+		<PackageReference Include="System.Text.Json" Version="9.0.2" />
 	</ItemGroup>
 
 	<ItemGroup>

sample/MudBlazor/MudBlazor.SampleApp.Shared/AddFluxExtension.cs

@@ -11,9 +11,11 @@ public static void AddFlux(this IServiceCollection services, string baseUrl)
         services.AddFlux(x =>
         {
             x.AddService("library-web-api")
-            .UsingRest(baseUrl.TrimEnd('/') + "/api")
+                .UsingRest(baseUrl.TrimEnd('/') + "/api")
+
                 .AddSet<Author, int>()
                     .WithEndpoint("authors")
+
                 .AddSet<Book, int>()
                     .WithEndpoint("books")
                     .WithPageEndpoint("books{query}");

sample/MudBlazor/MudBlazor.SampleApp.Shared/MudBlazor.SampleApp.Shared.csproj

@@ -8,8 +8,8 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-	  <PackageReference Include="BitzArt.Pagination" Version="1.15.1" />
-	  <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.0" />
+	  <PackageReference Include="BitzArt.Pagination" Version="1.16.1" />
+	  <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.2" />
 	</ItemGroup>
 
 	<ItemGroup>

sample/MudBlazor/MudBlazor.SampleApp/Data/MapDataEndpointsExtension.cs

@@ -37,7 +37,7 @@ public static void MapDataEndpoints(this WebApplication app)
 
             var orderDirection = desc ? OrderDirection.Descending : OrderDirection.Ascending;
 
-            q = string.IsNullOrWhiteSpace(order) 
+            q = string.IsNullOrWhiteSpace(order)
                 ? q.OrderBy(x => x.Id, orderDirection)
                 : q.Order(order, orderDirection);
 

src/BitzArt.Flux/BitzArt.Flux.csproj

@@ -26,21 +26,15 @@
 
 	<ItemGroup>
 		<PackageReference Include="BitzArt.LinqExtensions" Version="1.7.0" />
-		<PackageReference Include="BitzArt.Pagination" Version="1.15.1" />
-		<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.0" />
-		<PackageReference Include="Microsoft.Extensions.Options" Version="9.0.0" />
+		<PackageReference Include="BitzArt.Pagination" Version="1.16.1" />
+		<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.2" />
+		<PackageReference Include="Microsoft.Extensions.Options" Version="9.0.2" />
 	</ItemGroup>
 
 	<ItemGroup>
 		<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
 			<_Parameter1>BitzArt.Flux.Tests</_Parameter1>
 		</AssemblyAttribute>
-		<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
-			<_Parameter1>BitzArt.Flux.REST.Tests</_Parameter1>
-		</AssemblyAttribute>
-		<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
-			<_Parameter1>BitzArt.Flux.Json.Tests</_Parameter1>
-		</AssemblyAttribute>
 	</ItemGroup>
 
 </Project>

src/BitzArt.Flux/Models/FluxServicePreBuilder.cs → src/BitzArt.Flux/Builder/FluxServicePreBuilder.cs

@@ -6,6 +6,6 @@ internal class FluxServicePreBuilder(IServiceCollection services, IFluxFactory f
     : IFluxServicePreBuilder
 {
     public string? Name { get; set; } = name;
-    public IServiceCollection Services { get; init; } = services;
+    public IServiceCollection ServiceCollection { get; init; } = services;
     public IFluxFactory Factory { get; init; } = factory;
 }

src/BitzArt.Flux/Exceptions/FluxException.cs

@@ -0,0 +1,14 @@
+namespace BitzArt.Flux;
+
+/// <summary>
+/// An <see cref="Exception"/> thrown by the Flux library.
+/// </summary>
+public class FluxException : Exception
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FluxException"/> class.
+    /// </summary>
+    /// <param name="message">Error message.</param>
+    /// <param name="innerException">Inner exception.</param>
+    public FluxException(string message, Exception? innerException = null) : base(message, innerException) { }
+}

src/BitzArt.Flux/Exceptions/FluxMultipleServiceProviderFoundException.cs

@@ -0,0 +1,15 @@
+namespace BitzArt.Flux;
+
+/// <summary>
+/// An exception thrown when multiple Flux Service Providers are found.
+/// </summary>
+public class FluxMultipleServiceProviderFoundException : FluxException
+{
+    internal const string DefaultMessage = "Multiple matching Flux Service Providers were found.";
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FluxMultipleServiceProviderFoundException"/> class.
+    /// </summary>
+    public FluxMultipleServiceProviderFoundException(string message = DefaultMessage, Exception? innerException = null)
+        : base(message, innerException) { }
+}

src/BitzArt.Flux/Exceptions/FluxServiceProviderNotFoundException.cs

@@ -3,12 +3,13 @@
 /// <summary>
 /// An exception thrown when a Flux Service Provider is not found.
 /// </summary>
-public class FluxServiceProviderNotFoundException : Exception
+public class FluxServiceProviderNotFoundException : FluxException
 {
+    internal const string DefaultMessage = "Requested Flux Service Provider was not found.";
+
     /// <summary>
     /// Initializes a new instance of the <see cref="FluxServiceProviderNotFoundException"/> class.
     /// </summary>
-    public FluxServiceProviderNotFoundException()
-        : base("Requested Flux Service Provider was not found.")
-    { }
+    public FluxServiceProviderNotFoundException(string message = DefaultMessage, Exception? innerException = null)
+        : base(message, innerException) { }
 }

src/BitzArt.Flux/Exceptions/FluxSetAlreadyRegisteredException.cs

@@ -0,0 +1,28 @@
+namespace BitzArt.Flux;
+
+/// <summary>
+/// An exception thrown when a Flux Set is already registered,
+/// and a new one is being registered with the same name.
+/// </summary>
+public class FluxSetAlreadyRegisteredException : FluxException
+{
+    internal static string GetDefaultMessage(string name)
+        => $"An unnamed Flux Set for a model '{name}' was already registered previously. Consider giving specific names to different sets for this model.";
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FluxSetAlreadyRegisteredException"/> class.
+    /// </summary>
+    /// <param name="name">Model name.</param>
+    /// <param name="innerException">Inner exception.</param>
+    /// <returns>A new instance of the <see cref="FluxSetAlreadyRegisteredException"/> class.</returns>
+    public static FluxSetAlreadyRegisteredException ByModelName(string name, Exception? innerException = null)
+        => new(GetDefaultMessage(name), innerException);
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FluxSetAlreadyRegisteredException"/> class.
+    /// </summary>
+    /// <param name="message">Error message.</param>
+    /// <param name="innerException">Inner exception.</param>
+    public FluxSetAlreadyRegisteredException(string message, Exception? innerException = null)
+        : base(message, innerException) { }
+}

src/BitzArt.Flux/Exceptions/FluxSetConfigurationNotFoundException.cs

@@ -0,0 +1,14 @@
+namespace BitzArt.Flux;
+
+/// <summary>
+/// An exception thrown when a Flux Set Configuration is not found.
+/// </summary>
+public class FluxSetConfigurationNotFoundException : FluxException
+{
+    internal const string DefaultMessage = "Requested Set Configuration was not found.";
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FluxSetConfigurationNotFoundException"/> class.
+    /// </summary>
+    public FluxSetConfigurationNotFoundException(string message = DefaultMessage, Exception? innerException = null)
+        : base(message, innerException) { }
+}

src/BitzArt.Flux/Interfaces/IFluxServiceBuilder.cs → src/BitzArt.Flux/Interfaces/Builder/IFluxServiceBuilder.cs

@@ -11,7 +11,7 @@ public interface IFluxServiceBuilder
     /// <summary>
     /// Service collection where Flux Services are registered.
     /// </summary>
-    public IServiceCollection Services { get; }
+    public IServiceCollection ServiceCollection { get; }
 
     /// <summary>
     /// Flux Service Factory instance.

src/BitzArt.Flux/Interfaces/IFluxServicePreBuilder.cs → src/BitzArt.Flux/Interfaces/Builder/IFluxServicePreBuilder.cs

@@ -18,7 +18,7 @@ public interface IFluxServicePreBuilder
     /// <summary>
     /// The service collection where Flux Services are registered.
     /// </summary>
-    public IServiceCollection Services { get; }
+    public IServiceCollection ServiceCollection { get; }
 
     /// <summary>
     /// Flux Factory instance.

src/BitzArt.Flux/Interfaces/IFluxFactory.cs → src/BitzArt.Flux/Interfaces/Factory/IFluxFactory.cs

@@ -1,7 +1,7 @@
 namespace BitzArt.Flux;
 
 /// <summary>
-/// Internal Flux factory. Stores factories for configured services.
+/// Contains nested factories for configured services.
 /// </summary>
 public interface IFluxFactory
 {
@@ -25,5 +25,6 @@ public IFluxSetContext<TModel> GetSetContext<TModel>(IServiceProvider services,
     /// Resolves a context for a specific Flux Service.
     /// </summary>
     public IFluxSetContext<TModel, TKey> GetSetContext<TModel, TKey>(IServiceProvider services, string? serviceName = null, string? setName = null)
-        where TModel : class;
+        where TModel : class
+        where TKey : notnull;
 }