BlazorReports · andres-m-rodriguez · Mar 21, 2025 · Mar 21, 2025 · Mar 21, 2025 · Mar 21, 2025
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -10,6 +10,6 @@
     <PackageVersion Include="Microsoft.Extensions.Http.Polly" Version="8.0.0" />
     <PackageVersion Include="BlazorMonaco" Version="3.3.0" />
     <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="9.0.3" />
-    <PackageVersion Include="Swashbuckle.AspNetCore" Version="8.0.0" />
+    <PackageVersion Include="Swashbuckle.AspNetCore" Version="7.2.0" />
   </ItemGroup>
 </Project>
diff --git a/examples/SimpleReportServer/HelloReport.razor b/examples/SimpleReportServer/HelloReport.razor
@@ -1,3 +1,4 @@
+
 <h3>Hello @Data.Name</h3>
 
 @code {

diff --git a/examples/SimpleReportServer/Program.cs b/examples/SimpleReportServer/Program.cs
@@ -2,6 +2,7 @@
 using BlazorReports.Models;
 using ExampleTemplates.Reports;
 using SimpleReportServer;
+using SimpleReportServer.Reports;
 
 var builder = WebApplication.CreateSlimBuilder(args);
 
@@ -19,6 +20,10 @@
 
 var reportsGroup = app.MapGroup("reports");
 
+reportsGroup.MapBlazorReport<SimpleJsAsyncReport, SimpleJsAsyncReportData>(opts =>
+{
+  opts.JavascriptSettings.WaitForJavascriptCompletedSignal = true;
+});
 reportsGroup.MapBlazorReport<HelloReport, HelloReportData>();
 reportsGroup.MapBlazorReport<HelloReport, HelloReportData>(opts =>
 {

diff --git a/examples/SimpleReportServer/Reports/SimpleJsAsyncReport.razor b/examples/SimpleReportServer/Reports/SimpleJsAsyncReport.razor
@@ -0,0 +1,22 @@
+
+<p id="HelloWorld"></p>
+<script>
+
+    var element = document.getElementById("HelloWorld");
+
+
+    if (element) {
+      element.innerHTML = "<h1>Hello from JavaScript</h1>";
+    }
+
+    // Call the globally defined blazorReport.completed() to let BlazorReports know the report's contents have finished generating.
+    setTimeout(() => {
+      blazorReport.completed();
+    }, @Data.TimeSpan.TotalMilliseconds)
+
+</script>
+@code {
+  [Parameter]
+    public required SimpleJsAsyncReportData Data { get; set; }
+
+}
diff --git a/examples/SimpleReportServer/Reports/SimpleJsAsyncReportData.cs b/examples/SimpleReportServer/Reports/SimpleJsAsyncReportData.cs
@@ -0,0 +1,6 @@
+namespace SimpleReportServer.Reports;
+
+public record SimpleJsAsyncReportData(int TimeoutInSeconds)
+{
+  public TimeSpan TimeSpan => TimeSpan.FromSeconds(TimeoutInSeconds);
+};
diff --git a/examples/SimpleReportServer/wwwroot/js/HelloJavascriptData.js b/examples/SimpleReportServer/wwwroot/js/HelloJavascriptData.js
diff --git a/src/BlazorReports.Components/BlazorReportsTemplate.razor b/src/BlazorReports.Components/BlazorReportsTemplate.razor
@@ -1,29 +1,90 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-  <style>@((MarkupString)BaseStyles)</style>
+    <style>@((MarkupString)BaseStyles)</style>
+    <script>
+        // Define BlazorReport class
+        class BlazorReport {
+            constructor(signalName) {
+                this.signalName = signalName;
+            }
+
+            notReady() {
+                window[this.signalName] = "not-ready";
+            }
+
+            completed() {
+                window[this.signalName] = "ready";
+            }
+        }
+
+        // Create global instance with the provided signal name
+        window.blazorReport = new BlazorReport("@ReportIsReadySignal");
+
+                // Function to wait for signal change
+        window.waitForSignal = (timeoutMs = 5000, intervalMs = 50) => {
+          var expectedValue = 'ready'
+          return new Promise((resolve, reject) => {
+            const start = Date.now();
+
+            const check = () => {
+              if (window["@ReportIsReadySignal"] === expectedValue) {
+                clearInterval(interval);
+                resolve('Signal received');
+              } else if (Date.now() - start > timeoutMs) {
+                clearInterval(interval);
+                reject(new Error('Timeout waiting for signal'));
+              }
+            };
+
+            const interval = setInterval(check, intervalMs);
+            check(); // In case it's already ready
+          });
+        };
+    </script>
 </head>
 <body>
-<DynamicComponent Type="@ChildComponentType" Parameters="@ChildComponentParameters" />
+    <DynamicComponent Type="@ChildComponentType" Parameters="@ChildComponentParameters" />
+
+    @foreach (var script in Scripts)
+    {
+        <script>
+            @((MarkupString)@script.Value)
+        </script>
+    }
 </body>
 </html>
 
-
 @code {
-  /// <summary>
-  /// The base styles to be applied to the component.
-  /// </summary>
-  [Parameter]
-  public string BaseStyles { get; set; } = "";
-  /// <summary>
-  /// The type of the component to be rendered in the html body.
-  /// </summary>
-  [Parameter]
-  public Type ChildComponentType { get; set; } = null!;
-  /// <summary>
-  /// The parameters to be passed to the child component.
-  /// </summary>
-  [Parameter]
-  public IDictionary<string, object> ChildComponentParameters { get; set; } = null!;
+    /// <summary>
+    /// The base styles to be applied to the component.
+    /// </summary>
+    [Parameter]
+    public string BaseStyles { get; set; } = "";
+
+    /// <summary>
+    /// The type of the component to be rendered in the html body.
+    /// </summary>
+    [Parameter]
+    public Type ChildComponentType { get; set; } = null!;
+
+    /// <summary>
+    /// The parameters to be passed to the child component.
+    /// </summary>
+    [Parameter]
+    public IDictionary<string, object> ChildComponentParameters { get; set; } = null!;
+
+    /// <summary>
+    /// The scripts to be included in the html body.
+    /// </summary>
+    [Parameter]
+    public Dictionary<string, string> Scripts { get; set; } = new Dictionary<string, string>();
+
+    /// <summary>
+    /// The name of the JavaScript signal used to indicate when the report is ready.
+    /// </summary>
+    [Parameter]
+    public string ReportIsReadySignal { get; set; } = "reportIsReady";
+
 
 }
diff --git a/src/BlazorReports/Extensions/ReportExtensions.cs b/src/BlazorReports/Extensions/ReportExtensions.cs
@@ -110,7 +110,8 @@ CancellationToken token
             _ => (int?)null,
             _ => StatusCodes.Status503ServiceUnavailable,
             _ => StatusCodes.Status499ClientClosedRequest,
-            _ => StatusCodes.Status500InternalServerError
+            _ => StatusCodes.Status500InternalServerError,
+            _ => StatusCodes.Status408RequestTimeout
           );
 
           if (errorStatusCode is not null)
@@ -121,6 +122,7 @@ CancellationToken token
         }
       )
       .Produces<FileStreamHttpResult>(200, blazorReport.GetContentType())
+      .Produces(StatusCodes.Status408RequestTimeout)
       .Produces(StatusCodes.Status503ServiceUnavailable);
   }
 
@@ -174,7 +176,8 @@ CancellationToken token
             _ => (int?)null,
             _ => StatusCodes.Status503ServiceUnavailable,
             _ => StatusCodes.Status499ClientClosedRequest,
-            _ => StatusCodes.Status500InternalServerError
+            _ => StatusCodes.Status500InternalServerError,
+            _ => StatusCodes.Status408RequestTimeout
           );
 
           if (errorStatusCode is not null)
@@ -185,6 +188,7 @@ CancellationToken token
         }
       )
       .Produces<FileStreamHttpResult>(200, blazorReport.GetContentType())
+      .Produces(StatusCodes.Status408RequestTimeout)
       .Produces(StatusCodes.Status503ServiceUnavailable);
   }
 

diff --git a/src/BlazorReports/Extensions/ServiceCollectionExtensions.cs b/src/BlazorReports/Extensions/ServiceCollectionExtensions.cs
@@ -2,6 +2,7 @@
 using BlazorReports.Services;
 using BlazorReports.Services.BrowserServices;
 using BlazorReports.Services.BrowserServices.Factories;
+using BlazorReports.Services.JavascriptServices;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.AspNetCore.Routing.Constraints;
 using Microsoft.Extensions.DependencyInjection;
@@ -26,6 +27,8 @@ public static IServiceCollection AddBlazorReports(
   {
     services.Configure(options ?? (_ => { }));
     services.AddSingleton<BlazorReportRegistry>();
+    services.AddSingleton<JavascriptContainer>();
+
     services.AddSingleton<IConnectionFactory, ConnectionFactory>();
     services.AddSingleton<IBrowserFactory, BrowserFactory>();
     services.AddSingleton<IBrowserPageFactory, BrowserPageFactory>();

diff --git a/src/BlazorReports/Models/BlazorReport.cs b/src/BlazorReports/Models/BlazorReport.cs
@@ -44,4 +44,9 @@ public class BlazorReport
   /// The page settings to use for the report.
   /// </summary>
   public BlazorReportsPageSettings? PageSettings { get; set; }
+
+  /// <summary>
+  /// The current report javascript settings.
+  /// </summary>
+  public required BlazorReportCurrentReportJavascriptSettings CurrentReportJavascriptSettings { get; set; }
 }
diff --git a/src/BlazorReports/Models/BlazorReportCurrentReportJavascriptSettings.cs b/src/BlazorReports/Models/BlazorReportCurrentReportJavascriptSettings.cs
@@ -0,0 +1,32 @@
+namespace BlazorReports.Models;
+
+/// <summary>
+/// Settings for the internal javascript api
+/// </summary>
+public class BlazorReportCurrentReportJavascriptSettings
+{
+  /// <summary>
+  /// The signal that the report is ready
+  /// </summary>
+  public string ReportIsReadySignal { get; set; } = default!;
+
+  /// <summary>
+  /// Decides if the report should wait for the complete signal in the javascript
+  /// </summary>
+  public bool WaitForJavascriptCompletedSignal { get; set; }
+
+  /// <summary>
+  ///  The amount of time a reports javascript can take until it is considered to have timed out
+  /// </summary>
+  public TimeSpan? WaitForCompletedSignalTimeout { get; set; }
+
+  /// <summary>
+  /// The default settings for the current report javascript settings
+  /// </summary>
+  public static BlazorReportCurrentReportJavascriptSettings Default =>
+    new BlazorReportCurrentReportJavascriptSettings
+    {
+      WaitForJavascriptCompletedSignal = false,
+      WaitForCompletedSignalTimeout = TimeSpan.FromSeconds(3),
+    };
+}
diff --git a/src/BlazorReports/Models/BlazorReportGlobalJavascriptSettings.cs b/src/BlazorReports/Models/BlazorReportGlobalJavascriptSettings.cs
@@ -0,0 +1,24 @@
+namespace BlazorReports.Models;
+
+/// <summary>
+///
+/// </summary>
+public class BlazorReportGlobalJavascriptSettings
+{
+  /// <summary>
+  /// The signal that the report is ready
+  /// </summary>
+  public string ReportIsReadySignal { get; set; } = "reportIsReady";
+
+  /// <summary>
+  /// Decides if the report should wait for the complete signal in the javascript.
+  /// (Default: false)
+  /// </summary>
+  public bool WaitForJavascriptCompletedSignal { get; set; }
+
+  /// <summary>
+  ///  The amount of time a reports javascript can take until it is considered to have timed out
+  ///  (Default: null)
+  /// </summary>
+  public TimeSpan WaitForCompletedSignalTimeout { get; set; } = TimeSpan.FromSeconds(3);
+}
diff --git a/src/BlazorReports/Models/BlazorReportRegistrationOptions.cs b/src/BlazorReports/Models/BlazorReportRegistrationOptions.cs
@@ -29,4 +29,9 @@ public class BlazorReportRegistrationOptions
   /// Settings for generating a PDF
   /// </summary>
   public BlazorReportsPageSettings PageSettings { get; set; } = new();
+
+  /// <summary>
+  /// Javascript api settings
+  /// </summary>
+  public BlazorReportCurrentReportJavascriptSettings JavascriptSettings { get; set; } = new();
 }
diff --git a/src/BlazorReports/Models/BlazorReportRegistry.cs b/src/BlazorReports/Models/BlazorReportRegistry.cs
@@ -85,6 +85,8 @@ public BlazorReport AddReport<T>(BlazorReportRegistrationOptions? options = null
       Component = typeof(T),
       Data = null,
       PageSettings = options?.PageSettings,
+      CurrentReportJavascriptSettings =
+        options?.JavascriptSettings ?? BlazorReportCurrentReportJavascriptSettings.Default,
     };
     if (!string.IsNullOrEmpty(options?.BaseStylesPath))
     {
@@ -137,6 +139,8 @@ public BlazorReport AddReport<T, TD>(BlazorReportRegistrationOptions? options =
       Component = typeof(T),
       Data = typeof(TD),
       PageSettings = options?.PageSettings,
+      CurrentReportJavascriptSettings =
+        options?.JavascriptSettings ?? BlazorReportCurrentReportJavascriptSettings.Default,
     };
     if (!string.IsNullOrEmpty(options?.BaseStylesPath))
     {

diff --git a/src/BlazorReports/Models/BlazorReportsOptions.cs b/src/BlazorReports/Models/BlazorReportsOptions.cs
@@ -24,4 +24,9 @@ public class BlazorReportsOptions
   /// Settings for generating a PDF
   /// </summary>
   public BlazorReportsPageSettings PageSettings { get; set; } = new();
+
+  /// <summary>
+  /// Javascript api settings
+  /// </summary>
+  public BlazorReportGlobalJavascriptSettings GlobalJavascriptSettings { get; set; } = new();
 }
diff --git a/src/BlazorReports/Services/BrowserServices/Browser.cs b/src/BlazorReports/Services/BrowserServices/Browser.cs
@@ -21,6 +21,7 @@ internal sealed class Browser(
   DirectoryInfo dataDirectory,
   Connection connection,
   BlazorReportsBrowserOptions browserOptions,
+  BlazorReportGlobalJavascriptSettings globalJavascriptSettings,
   ILogger logger,
   IBrowserPageFactory browserPageFactory
 ) : IAsyncDisposable
@@ -30,11 +31,18 @@ IBrowserPageFactory browserPageFactory
   private readonly SemaphoreSlim _poolLock = new(1, 1);
 
   public async ValueTask<
-    OneOf<Success, ServerBusyProblem, OperationCancelledProblem, BrowserProblem>
+    OneOf<
+      Success,
+      ServerBusyProblem,
+      OperationCancelledProblem,
+      BrowserProblem,
+      CompletedSignalTimeoutProblem
+    >
   > GenerateReport(
     PipeWriter pipeWriter,
     string html,
     BlazorReportsPageSettings pageSettings,
+    BlazorReportCurrentReportJavascriptSettings currentReportJavascriptSettings,
     CancellationToken cancellationToken
   )
   {
@@ -92,6 +100,24 @@ out browserPage
       try
       {
         await browserPage.DisplayHtml(html, cancellationToken);
+        var shouldReportAwaitJavascript =
+          currentReportJavascriptSettings.WaitForJavascriptCompletedSignal
+          || globalJavascriptSettings.WaitForJavascriptCompletedSignal;
+        if (shouldReportAwaitJavascript)
+        {
+          TimeSpan globalTimeout = globalJavascriptSettings.WaitForCompletedSignalTimeout;
+          TimeSpan? currentReportTimeout =
+            currentReportJavascriptSettings.WaitForCompletedSignalTimeout;
+
+          TimeSpan timeout = currentReportTimeout ?? globalTimeout;
+
+          var didNotHitTimeOut = await browserPage.WaitForJsFlagAsync(timeout, cancellationToken);
+          if (!didNotHitTimeOut)
+          {
+            return new CompletedSignalTimeoutProblem();
+          }
+        }
+
         await browserPage.ConvertPageToPdf(pipeWriter, pageSettings, cancellationToken);
       }
       catch (Exception e)