Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.

Commit 3c7293d

Browse files
josephdecockjosephdecock
committed
Still more XML DOC
1 parent 4504958 commit 3c7293d

9 files changed

+84
-30
lines changed

‎Duende.Bff.sln

+31-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
Microsoft Visual Studio Solution File, Format Version 12.00
33
# Visual Studio Version 17
44
VisualStudioVersion = 17.9.34414.90
@@ -43,11 +43,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duende.Bff.Blazor", "src\Du
4343
EndProject
4444
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duende.Bff.Blazor.Client", "src\Duende.Bff.Blazor.Client\Duende.Bff.Blazor.Client.csproj", "{DDB9C401-6B1F-4727-A4CB-932034FBF94E}"
4545
EndProject
46-
EndProject
4746
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Blazor.Wasm.Bff", "samples\Blazor.Wasm\Blazor.Wasm.Bff\Blazor.Wasm.Bff.csproj", "{BC21ADB7-F2CA-44F0-B6ED-0405E1EFFFA3}"
4847
EndProject
4948
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Blazor.Wasm.Client", "samples\Blazor.Wasm\Blazor.Wasm.Client\Blazor.Wasm.Client.csproj", "{4E69FCF6-AE76-4F6D-98B8-969E9D244AE4}"
5049
EndProject
50+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Duende.Bff.Blazor.Client.UnitTests", "test\Duende.Bff.Blazor.Client.UnitTests\Duende.Bff.Blazor.Client.UnitTests.csproj", "{001840D4-8B83-4A8C-AF2C-5429D4F9A370}"
51+
EndProject
52+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Duende.Bff.Blazor.UnitTests", "test\Duende.Bff.Blazor.UnitTests\Duende.Bff.Blazor.UnitTests.csproj", "{2A04808A-A06C-4F10-87B9-2D12E065F729}"
53+
EndProject
5154
Global
5255
GlobalSection(SolutionConfigurationPlatforms) = preSolution
5356
Debug|Any CPU = Debug|Any CPU
@@ -250,6 +253,30 @@ Global
250253
{DDB9C401-6B1F-4727-A4CB-932034FBF94E}.Release|x64.Build.0 = Release|Any CPU
251254
{DDB9C401-6B1F-4727-A4CB-932034FBF94E}.Release|x86.ActiveCfg = Release|Any CPU
252255
{DDB9C401-6B1F-4727-A4CB-932034FBF94E}.Release|x86.Build.0 = Release|Any CPU
256+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
257+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Debug|Any CPU.Build.0 = Debug|Any CPU
258+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Debug|x64.ActiveCfg = Debug|Any CPU
259+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Debug|x64.Build.0 = Debug|Any CPU
260+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Debug|x86.ActiveCfg = Debug|Any CPU
261+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Debug|x86.Build.0 = Debug|Any CPU
262+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Release|Any CPU.ActiveCfg = Release|Any CPU
263+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Release|Any CPU.Build.0 = Release|Any CPU
264+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Release|x64.ActiveCfg = Release|Any CPU
265+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Release|x64.Build.0 = Release|Any CPU
266+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Release|x86.ActiveCfg = Release|Any CPU
267+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370}.Release|x86.Build.0 = Release|Any CPU
268+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
269+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Debug|Any CPU.Build.0 = Debug|Any CPU
270+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Debug|x64.ActiveCfg = Debug|Any CPU
271+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Debug|x64.Build.0 = Debug|Any CPU
272+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Debug|x86.ActiveCfg = Debug|Any CPU
273+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Debug|x86.Build.0 = Debug|Any CPU
274+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Release|Any CPU.ActiveCfg = Release|Any CPU
275+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Release|Any CPU.Build.0 = Release|Any CPU
276+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Release|x64.ActiveCfg = Release|Any CPU
277+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Release|x64.Build.0 = Release|Any CPU
278+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Release|x86.ActiveCfg = Release|Any CPU
279+
{2A04808A-A06C-4F10-87B9-2D12E065F729}.Release|x86.Build.0 = Release|Any CPU
253280
EndGlobalSection
254281
GlobalSection(SolutionProperties) = preSolution
255282
HideSolutionNode = FALSE
@@ -271,6 +298,8 @@ Global
271298
{CBB98134-92F5-487D-8CA3-84C19FF46775} = {E14F66D1-EA3E-40C6-835A-91A4382D4646}
272299
{E02DF032-C17F-4D0C-9CAA-3BD3CC9E4F84} = {3C549079-A502-4B40-B051-5278915AE91B}
273300
{DDB9C401-6B1F-4727-A4CB-932034FBF94E} = {3C549079-A502-4B40-B051-5278915AE91B}
301+
{001840D4-8B83-4A8C-AF2C-5429D4F9A370} = {B2A776DB-385B-4AD4-96A5-61746FD909C3}
302+
{2A04808A-A06C-4F10-87B9-2D12E065F729} = {B2A776DB-385B-4AD4-96A5-61746FD909C3}
274303
EndGlobalSection
275304
GlobalSection(ExtensibilityGlobals) = postSolution
276305
SolutionGuid = {3DAD5980-4688-4794-9CF0-6F3CB67194E7}

‎src/Duende.Bff.Blazor.Client/BffBlazorOptions.cs

+12-12
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,38 @@
44
namespace Duende.Bff.Blazor.Client;
55

66
/// <summary>
7-
/// Options for Blazor BFF
7+
/// Options for Blazor BFF
88
/// </summary>
99
public class BffBlazorOptions
1010
{
1111
/// <summary>
12-
/// The base path to use for remote APIs.
12+
/// The base path to use for remote APIs.
1313
/// </summary>
1414
public string RemoteApiPath { get; set; } = "remote-apis/";
1515

1616
/// <summary>
17-
/// The base address to use for remote APIs. If unset (the default), the
18-
/// blazor hosting environment's base address is used.
17+
/// The base address to use for remote APIs. If unset (the default), the
18+
/// blazor hosting environment's base address is used.
1919
/// </summary>
2020
public string? RemoteApiBaseAddress { get; set; } = null;
2121

2222
/// <summary>
23-
/// The base address to use for the state provider's calls to the
24-
/// /bff/user endpoint. If unset (the default), the blazor hosting
25-
/// environment's base address is used.
23+
/// The base address to use for the state provider's calls to the /bff/user
24+
/// endpoint. If unset (the default), the blazor hosting environment's base
25+
/// address is used.
2626
/// </summary>
2727
public string? StateProviderBaseAddress { get; set; } = null;
2828

2929
/// <summary>
30-
/// The delay, in milliseconds, before the AuthenticationStateProvider
31-
/// will start polling the /bff/user endpoint. Defaults to 1000 ms.
30+
/// The delay, in milliseconds, before the AuthenticationStateProvider will
31+
/// start polling the /bff/user endpoint. Defaults to 1000 ms.
3232
/// </summary>
3333
public int StateProviderPollingDelay { get; set; } = 1000;
3434

3535
/// <summary>
36-
/// The delay, in milliseconds, between polling requests by the
37-
/// AuthenticationStateProvider to the /bff/user endpoint. Defaults to
38-
/// 5000 ms.
36+
/// The delay, in milliseconds, between polling requests by the
37+
/// AuthenticationStateProvider to the /bff/user endpoint. Defaults to 5000
38+
/// ms.
3939
/// </summary>
4040
public int StateProviderPollingInterval { get; set; } = 5000;
4141
}

‎src/Duende.Bff.Blazor.Client/BffClientAuthenticationStateProvider.cs

+2-4
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ public class BffClientAuthenticationStateProvider : AuthenticationStateProvider
2222
private ClaimsPrincipal _cachedUser = new(new ClaimsIdentity());
2323

2424
/// <summary>
25-
/// An <see cref="AuthenticationStateProvider"/> intended for use in
26-
/// Blazor WASM. It polls the /bff/user endpoint to monitor session
27-
/// state.
25+
/// An <see cref="AuthenticationStateProvider"/> intended for use in Blazor
26+
/// WASM. It polls the /bff/user endpoint to monitor session state.
2827
/// </summary>
2928
public BffClientAuthenticationStateProvider(
3029
PersistentComponentState state,
@@ -48,7 +47,6 @@ public override async Task<AuthenticationState> GetAuthenticationStateAsync()
4847
var user = await GetUser();
4948
var state = new AuthenticationState(user);
5049

51-
// Periodically
5250
if (user.Identity is { IsAuthenticated: true })
5351
{
5452
_logger.LogInformation("starting background check..");

‎src/Duende.Bff.Blazor.Client/ServiceCollectionExtensions.cs

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ namespace Duende.Bff.Blazor.Client;
1010

1111
public static class ServiceCollectionExtensions
1212
{
13+
/// <summary>
14+
/// Adds Duende.BFF services to a Blazor Client (wasm) application.
15+
/// </summary>
16+
/// <param name="configureAction">A callback used to set <see cref="BffBlazorOptions"/>.</param>
1317
public static IServiceCollection AddBffBlazorClient(this IServiceCollection services,
1418
Action<BffBlazorOptions>? configureAction = null)
1519
{

‎src/Duende.Bff.Blazor/ServerSideTokenStore.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
namespace Duende.Bff.Blazor;
1111

1212
/// <summary>
13-
/// A token store that retrieves tokens from server side sessions.
13+
/// A token store that retrieves tokens from server side sessions.
1414
/// </summary>
1515
public class ServerSideTokenStore(
1616
IStoreTokensInAuthenticationProperties tokensInAuthProperties,

‎src/Duende.Bff.Shared/ClaimLite.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44
namespace Duende.Bff;
55

66
/// <summary>
7-
/// Serialization friendly claim
7+
/// Serialization friendly claim
88
/// </summary>
99
public class ClaimLite
1010
{
1111
/// <summary>
12-
/// The type
12+
/// The type
1313
/// </summary>
1414
public string Type { get; init; } = default!;
1515

1616
/// <summary>
17-
/// The value
17+
/// The value
1818
/// </summary>
1919
public string Value { get; init; } = default!;
2020

2121
/// <summary>
22-
/// The value type
22+
/// The value type
2323
/// </summary>
2424
public string? ValueType { get; init; }
2525
}

‎src/Duende.Bff.Shared/ClaimsLiteExtensions.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Duende.Bff;
88
public static class ClaimsLiteExtensions
99
{
1010
/// <summary>
11-
/// Converts a ClaimsPrincipalLite to ClaimsPrincipal
11+
/// Converts a ClaimsPrincipalLite to ClaimsPrincipal
1212
/// </summary>
1313
public static ClaimsPrincipal ToClaimsPrincipal(this ClaimsPrincipalLite principal)
1414
{
@@ -21,7 +21,7 @@ public static ClaimsPrincipal ToClaimsPrincipal(this ClaimsPrincipalLite princip
2121
}
2222

2323
/// <summary>
24-
/// Converts a ClaimsPrincipal to ClaimsPrincipalLite
24+
/// Converts a ClaimsPrincipal to ClaimsPrincipalLite
2525
/// </summary>
2626
public static ClaimsPrincipalLite ToClaimsPrincipalLite(this ClaimsPrincipal principal)
2727
{

‎src/Duende.Bff.Shared/ClaimsPrincipalLite.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44
namespace Duende.Bff;
55

66
/// <summary>
7-
/// Serialization friendly ClaimsPrincipal
7+
/// Serialization friendly ClaimsPrincipal
88
/// </summary>
99
public class ClaimsPrincipalLite
1010
{
1111
/// <summary>
12-
/// The authentication type
12+
/// The authentication type
1313
/// </summary>
1414
public string? AuthenticationType { get; init; }
1515

1616
/// <summary>
17-
/// The name claim type
17+
/// The name claim type
1818
/// </summary>
1919
public string? NameClaimType { get; init; }
2020

2121
/// <summary>
22-
/// The role claim type
22+
/// The role claim type
2323
/// </summary>
2424
public string? RoleClaimType { get; init; }
2525

2626
/// <summary>
27-
/// The claims
27+
/// The claims
2828
/// </summary>
2929
public ClaimLite[] Claims { get; init; } = default!;
3030
}

‎test/Duende.Bff.Blazor.UnitTests/Duende.Bff.Blazor.UnitTests.csproj

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFramework>net8.0</TargetFramework>
5+
<ImplicitUsings>enable</ImplicitUsings>
6+
<Nullable>enable</Nullable>
7+
8+
<IsPackable>false</IsPackable>
9+
<IsTestProject>true</IsTestProject>
10+
</PropertyGroup>
11+
12+
<ItemGroup>
13+
<PackageReference Include="coverlet.collector" Version="6.0.0" />
14+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
15+
<PackageReference Include="xunit" Version="2.5.3" />
16+
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.3" />
17+
</ItemGroup>
18+
19+
<ItemGroup>
20+
<Using Include="Xunit" />
21+
</ItemGroup>
22+
23+
</Project>

0 commit comments

Comments
 (0)