report: added support for json report documents

payrun job: added job period info
main layout and nav menu: fixed update of culture change
updated verion to 0.9.0-beta.5

Author: Jani Giannoudis

Core/PayrollEngine.WebApp.Core.csproj

@@ -12,7 +12,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="PayrollEngine.Client.Core" Version="0.9.0-beta.4" />
+		<PackageReference Include="PayrollEngine.Client.Core" Version="0.9.0-beta.5" />
 		<PackageReference Include="Microsoft.AspNetCore.Components" Version="9.0.3" />
 		<PackageReference Include="Blazored.LocalStorage" Version="4.5.0" />
 		<PackageReference Include="Microsoft.JSInterop" Version="9.0.3" />

Directory.Build.props

@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<TargetFramework>net9.0</TargetFramework>
-		<Version>0.9.0-beta.4</Version>
+		<Version>0.9.0-beta.5</Version>
 		<FileVersion>0.9.0</FileVersion>
 		<InformationalVersion></InformationalVersion>
 		<Authors>Jani Giannoudis</Authors>

Presentation/LocalizerService.cs

@@ -45,6 +45,10 @@ public Localizer Localizer
         }
     }
 
+    /// <inheritdoc />
+    public void Invalidate() =>
+        localizer = null;
+
     private bool BuildLocalizer()
     {
         if (localizer != null)

Presentation/PayrollEngine.WebApp.Presentation.csproj

@@ -8,7 +8,7 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="9.0.3" />
-		<PackageReference Include="PayrollEngine.Document" Version="0.9.0-beta.4" />
+		<PackageReference Include="PayrollEngine.Document" Version="0.9.0-beta.5" />
 		<PackageReference Include="MudBlazor" Version="8.3.0" />
 		<PackageReference Include="NPOI" Version="2.7.2" />
 	</ItemGroup>

Presentation/Payrun/PayrunJobDialog.razor

@@ -1,6 +1,6 @@
-@using PayrollEngine.WebApp.ViewModel
+@using System.Globalization
 @using PayrollEngine.WebApp.Shared
-@using System.Globalization
+@using PayrollEngine.WebApp.ViewModel
 
 <MudDialog Style="min-width: 30em;" TitleClass="mud-theme-primary pe-dialog-title">
     <DialogContent>
@@ -13,7 +13,7 @@
             {
                 @* legal job: new *@
                 <MudPaper Class="pa-4"
-                          Style="min-width: 25em; max-width: 40em">
+                Style="min-width: 25em; max-width: 40em">
                     <MudStack Spacing="0">
                         <MudText Typo="Typo.h6">@Localizer.PayrunJob.New</MudText>
 
@@ -24,7 +24,7 @@
                         <MudText Class="pr-4">@GetUserName(PayrunJob.CreatedUserId)</MudText>
 
                         <MudInputLabel Class="pt-4">@Localizer.PayrunJob.JobPeriod</MudInputLabel>
-                        <MudText Class="pr-4">@PayrunJob.PeriodStart.ToCompactString()</MudText>
+                        <MudText Class="pr-4">@Period</MudText>
 
                         @if (PayrunJob.EvaluationDate != null)
                         {
@@ -33,22 +33,22 @@
                         }
 
                         <PayrunEmployeeInfo Class="pt-4" Employees="@Employees"
-                                            SelectedEmployees="@(PayrunJob.Employees?.Select(x => x.EmployeeId).ToList() ?? [])" />
+                        SelectedEmployees="@(PayrunJob.Employees?.Select(x => x.EmployeeId).ToList() ?? [])" />
 
                         <MudInputLabel Class="pt-4">@Localizer.PayrunJob.JobReason</MudInputLabel>
                         <MudText Class="pr-4">@PayrunJob.CreatedReason</MudText>
 
                         @if (PayrunJob.Attributes != null && PayrunJob.Attributes.Any())
                         {
                             <PayrunParameterInfo Class="pt-4" Culture="@Culture"
-                                                 ParameterAttributes="PayrunJob.Attributes" />
+                            ParameterAttributes="PayrunJob.Attributes" />
                         }
                     </MudStack>
                 </MudPaper>
 
                 @* legal job: draft *@
                 <MudPaper Class="pa-4" Elevation="@(PayrunJob.JobStatus.IsDraft() ? 4 : 1)"
-                          Style="min-width: 15em; max-width: 25em">
+                Style="min-width: 15em; max-width: 25em">
                     <MudStack Spacing="0">
                         <MudText Typo="Typo.h6" Color="@(PayrunJob.JobStatus.IsDraft() ? Color.Tertiary : Color.Default)">
                             @Localizer.Enum(PayrunJobStatus.Draft)
@@ -66,10 +66,10 @@
                 @if (PayrunJob.Released.HasValue)
                 {
                     <MudPaper Class="pa-4" Elevation="@(PayrunJob.JobStatus.IsRelease() ? 4 : 1)"
-                              Style="min-width: 15em; max-width: 25em">
+                    Style="min-width: 15em; max-width: 25em">
                         <MudStack Spacing="0">
                             <MudText Typo="Typo.h6"
-                                     Color="@(PayrunJob.JobStatus == PayrunJobStatus.Release ? Color.Tertiary : Color.Default)">
+                            Color="@(PayrunJob.JobStatus == PayrunJobStatus.Release ? Color.Tertiary : Color.Default)">
                                 @Localizer.Enum(PayrunJobStatus.Release)
                             </MudText>
 
@@ -86,10 +86,10 @@
                 @if (PayrunJob.Processed.HasValue)
                 {
                     <MudPaper Class="pa-4" Elevation="@(PayrunJob.JobStatus.IsProcess() ? 4 : 1)"
-                              Style="min-width: 15em; max-width: 25em">
+                    Style="min-width: 15em; max-width: 25em">
                         <MudStack Spacing="0">
                             <MudText Typo="Typo.h6"
-                                     Color="@(PayrunJob.JobStatus == PayrunJobStatus.Process ? Color.Tertiary : Color.Default)">
+                            Color="@(PayrunJob.JobStatus == PayrunJobStatus.Process ? Color.Tertiary : Color.Default)">
                                 @Localizer.Enum(PayrunJobStatus.Process)
                             </MudText>
 
@@ -106,10 +106,10 @@
                 @if (PayrunJob.Finished.HasValue && PayrunJob.JobStatus is PayrunJobStatus.Complete)
                 {
                     <MudPaper Class="pa-4" Elevation="@(PayrunJob.JobStatus.IsComplete() ? 4 : 1)"
-                              Style="min-width: 15em; max-width: 25em">
+                    Style="min-width: 15em; max-width: 25em">
                         <MudStack Spacing="0">
                             <MudText Typo="Typo.h6"
-                                     Color="@(PayrunJob.JobStatus == PayrunJobStatus.Complete ? Color.Tertiary : Color.Default)">
+                            Color="@(PayrunJob.JobStatus == PayrunJobStatus.Complete ? Color.Tertiary : Color.Default)">
                                 @Localizer.Enum(PayrunJobStatus.Complete)
                             </MudText>
 
@@ -126,7 +126,7 @@
                 @if (PayrunJob.Finished.HasValue && PayrunJob.JobStatus is PayrunJobStatus.Cancel or PayrunJobStatus.Abort)
                 {
                     <MudPaper Class="pa-4" Elevation="4"
-                              Style="min-width: 15em; max-width: 25em">
+                    Style="min-width: 15em; max-width: 25em">
                         <MudStack Spacing="0">
                             <MudText Typo="Typo.h6" Color="Color.Error">@PayrunJob.JobStatus</MudText>
 
@@ -143,7 +143,7 @@
             {
                 @* forecast job *@
                 <MudPaper Class="pa-4" Elevation="4"
-                          Style="min-width: 35em; max-width: 50em">
+                Style="min-width: 35em; max-width: 50em">
                     <MudStack Spacing="0">
                         <MudText Typo="Typo.h6">@Localizer.PayrunJob.New</MudText>
                         <MudInputLabel Class="pt-4">@Localizer.PayrunJob.JobDate</MudInputLabel>
@@ -157,7 +157,7 @@
                         <MudInputLabel Class="pt-4">@Localizer.PayrunJob.JobReason</MudInputLabel>
                         <MudText Class="pr-4">@PayrunJob.CreatedReason</MudText>
                         <PayrunEmployeeInfo Class="pt-4" Employees="@Employees"
-                                            SelectedEmployees="@(PayrunJob.Employees?.Select(x => x.EmployeeId).ToList() ?? [])" />
+                        SelectedEmployees="@(PayrunJob.Employees?.Select(x => x.EmployeeId).ToList() ?? [])" />
                         @if (PayrunJob.Attributes != null && PayrunJob.Attributes.Any())
                         {
                             <PayrunParameterInfo Class="pt-4" ParameterAttributes="@PayrunJob.Attributes" />
@@ -181,9 +181,11 @@
     [Parameter] public PayrunJob PayrunJob { get; set; }
     [Parameter] public List<PayrollEngine.WebApp.User> Users { get; set; } = [];
     [Parameter] public List<Employee> Employees { get; set; } = [];
+
     [Inject] private ILocalizerService LocalizerService { get; set; }
 
     private Localizer Localizer => LocalizerService.Localizer;
+    private DatePeriod Period => new(PayrunJob.PeriodStart, PayrunJob.PeriodEnd);
 
     private void Close() => MudDialog.Close(DialogResult.Ok(true));
 

Presentation/Payrun/PayrunJobSetup.cs

@@ -10,7 +10,12 @@ public class PayrunJobSetup
     /// <summary>
     /// The payrun period date
     /// </summary>
-    public DateTime? PeriodStart { get; set; }
+    public DateTime? PeriodDate { get; set; }
+
+    /// <summary>
+    /// The payrun period
+    /// </summary>
+    public DatePeriod Period { get; set; }
 
     /// <summary>
     /// The payrun evaluation date
@@ -52,7 +57,7 @@ public class PayrunJobSetup
     /// </summary>
     /// <returns>True for a valid legal job</returns>
     public bool IsValidLegalJob() =>
-        PeriodStart.HasValue &&
+        PeriodDate.HasValue &&
         !string.IsNullOrWhiteSpace(JobName) &&
         !string.IsNullOrWhiteSpace(Reason) &&
         ValidParameters();

Presentation/Payrun/PayrunStartDialog.razor

@@ -31,7 +31,7 @@
                     @* job period *@
                     <tr>
                         <td style="width: 20%">@Localizer.PayrunJob.JobPeriod</td>
-                        <td>@Setup.PeriodStart?.ToCompactString()</td>
+                        <td>@Period</td>
                     </tr>
 
                     @* job evaluation *@
@@ -124,12 +124,13 @@
 @code {
 
     [CascadingParameter] IMudDialogInstance MudDialog { get; set; }
-    [Parameter] public List<Employee> Employees { get; set; }
     [Parameter] public Client.Model.Tenant Tenant { get; set; }
     [Parameter] public User User { get; set; }
     [Parameter] public Client.Model.Payroll Payroll { get; set; }
+    [Parameter] public List<Employee> Employees { get; set; }
     [Parameter] public int PayrunId { get; set; }
     [Parameter] public PayrunJobSetup Setup { get; set; }
+    [Parameter] public DatePeriod Period { get; set; }
 
     [Inject] private IPayrunJobService PayrunJobService { get; set; }
     [Inject] private IUserNotificationService UserNotification { get; set; }
@@ -165,7 +166,7 @@
 
     private async Task Start()
     {
-        if (!Setup.PeriodStart.HasValue)
+        if (!Setup.PeriodDate.HasValue)
         {
             return;
         }
@@ -176,7 +177,7 @@
             StateHasChanged();
 
             // ensure UTC without the same date and time
-            var jobPeriod = DateTime.SpecifyKind(Setup.PeriodStart.Value, DateTimeKind.Utc);
+            var jobPeriod = DateTime.SpecifyKind(Setup.PeriodDate.Value, DateTimeKind.Utc);
 
             // employees
             List<string> employeeIdentifiers = null;

Presentation/Report/ReportBuildDialog.razor

@@ -80,8 +80,19 @@
             @* download buttons *@
             @if (!Completed && !Failed)
             {
+                @* Json *@
+                @if (SupportedDocumentType(DocumentType.Json))
+                {
+                    <MudButton Variant="@Globals.ButtonVariant"
+                               Color="Color.Tertiary"
+                               Disabled="@(!Valid || Started)"
+                               OnClick="@(() => StartAsync(DocumentType.Json))">
+                        @Localizer.Report.Json
+                    </MudButton>
+                }
+
                 @* Xml *@
-                @if (SupportedDocumentType(DocumentType.Excel))
+                @if (SupportedDocumentType(DocumentType.Xml))
                 {
                     <MudButton Variant="@Globals.ButtonVariant"
                                Color="Color.Tertiary"

Presentation/Report/ReportBuildDialog.razor.cs

@@ -72,7 +72,7 @@ private bool HasVisibleParameters() =>
         EditReport.ViewParameters.Count(x => x.Attributes?.GetHidden(Culture) ?? false) != EditReport.ViewParameters.Count;
 
     private bool SupportedDocumentType(DocumentType documentType) =>
-        documentType == DocumentType.Excel || DataMerge.IsMergeable(documentType);
+        documentType is DocumentType.Json or DocumentType.Excel || DataMerge.IsMergeable(documentType);
 
     /// <summary>
     /// Case info from build and validate
@@ -172,8 +172,12 @@ await UserNotification.ShowErrorMessageBoxAsync(Localizer, Localizer.Report.Repo
                             new MemoryStream(Encoding.ASCII.GetBytes(ReportTemplate.Content)),
                             dataSet, documentType, documentMetadata, mergeParameters);
                         break;
+                    case DocumentType.Json:
+                        // serialize data set as dictionary
+                        var json = dataSet.Json();
+                        documentStream = new MemoryStream(Encoding.UTF8.GetBytes(json));
+                        break;
                     case DocumentType.Xml:
-                    case DocumentType.XmlRaw:
                         // xml
                         var xml = XmlTool.IsContentTypeXsl(ReportTemplate.ContentType) ?
                             // xsl report
@@ -183,7 +187,7 @@ await UserNotification.ShowErrorMessageBoxAsync(Localizer, Localizer.Report.Repo
                         if (string.IsNullOrWhiteSpace(xml))
                         {
                             await UserNotification.ShowErrorMessageBoxAsync(Localizer, Localizer.Report.Report,
-                                Localizer.Report.EmptyXmlRaw(reportName));
+                                Localizer.Report.EmptyXml(reportName));
                             break;
                         }
 

Presentation/UserSession.cs

@@ -96,6 +96,11 @@ public void SetDefaultFeatures(IEnumerable<Feature> defaultFeatures) =>
     /// </summary>
     public AsyncEvent<User> UserChanged { get; set; }
 
+    /// <summary>
+    /// User state changed event
+    /// </summary>
+    public AsyncEvent<User> UserStateChanged { get; set; }
+
     /// <summary>
     /// User login
     /// </summary>
@@ -129,17 +134,21 @@ public async Task LoginAsync(Tenant userTenant, User user)
         await ChangeTenantAsync(userTenant, user);
 
         // update state
-        UpdateUserState();
+        await UpdateUserStateAsync();
     }
 
     /// <summary>
     /// Update the current user state, including culture and value formatter
     /// </summary>
-    public void UpdateUserState()
+    public async Task UpdateUserStateAsync()
     {
-        var cultureName = GetUserCulture()  ?? CultureInfo.CurrentCulture.Name;
+        var cultureName = GetUserCulture() ?? CultureInfo.CurrentCulture.Name;
         var culture = CultureService.GetCulture(cultureName).CultureInfo;
         ValueFormatter = new ValueFormatter(culture);
+        if (User != null)
+        {
+            await (UserStateChanged?.InvokeAsync(this, User) ?? Task.CompletedTask);
+        }
     }
 
     /// <summary>