Merge pull request #160 from Hazeolation/feature/152-add-show-hide-buttons-for-comm-box

Feature/152 Add show and hide buttons for commentator box controls

Author: BucketRaphi

Backend/DSB.StreamBackend/Context/StreamToolDbContext.cs

@@ -1,5 +1,6 @@
 using Microsoft.EntityFrameworkCore;
 using DSB.StreamBackend.Models;
+using DSB.StreamBackend.Enums;
 
 namespace DSB.StreamBackend.Context;
 
@@ -42,12 +43,35 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         modelBuilder.Entity<MapStateEntity>()
             .HasKey(x => x.Id);
 
+        modelBuilder.Entity<SocialsEntity>()
+            .HasKey(x => x.Id);
+
+        modelBuilder.Entity<CommentatorBoxTimeDataEntity>()
+            .HasKey(x => x.Id);
+
         modelBuilder.Entity<BroadcastStateEntity>()
             .HasMany(x => x.Maps)
             .WithOne(x => x.BroadcastState)
             .HasForeignKey(x => x.BroadcastStateEntityId)
             .OnDelete(DeleteBehavior.Cascade);
 
+        modelBuilder.Entity<SocialsEntity>()
+            .HasData(new SocialsEntity
+            {
+                Id = 1,
+                XHandle = string.Empty,
+                DiscordInvite = string.Empty
+            });
+
+        modelBuilder.Entity<CommentatorBoxTimeDataEntity>()
+            .HasData(new CommentatorBoxTimeDataEntity
+            {
+                Id = 1,
+                ShowDisplayIntervalInSeconds = 50,
+                HideDisplayIntervalInSeconds = 5,
+                DisplayMode = (int)CommBoxDisplayMode.Manual
+            });
+
         modelBuilder.Entity<BroadcastStateEntity>()
             .HasData(new BroadcastStateEntity
             {

Backend/DSB.StreamBackend/Dtos/CommentatorBoxTimeDataDto.cs

@@ -1,3 +1,5 @@
+using DSB.StreamBackend.Enums;
+
 namespace DSB.StreamBackend.Dtos;
 
 /// <summary>
@@ -9,14 +11,21 @@ public class CommentatorBoxTimeDataDto
     /// Gets or sets the single identifier for the commentator box time data
     /// </summary>
     public int Id { get; set; } = 1;
-    
+
     /// <summary>
-    /// Gets or sets the time in seconds that the display should be visible
+    /// Gets or sets the time in seconds that sets when the display should be visible again
     /// </summary>
     public int ShowDisplayIntervalInSeconds { get; set; } = 0;
 
     /// <summary>
-    /// Gets or sets the time in seconds that the display should be hidden
+    /// Gets or sets the time in seconds that sets when the display should be hidden again
     /// </summary>
     public int HideDisplayIntervalInSeconds { get; set; } = 0;
+
+    /// <summary>
+    /// Gets or sets the display mode in which the blending in and out happens
+    /// 0 - Manual, the streamer has to click a button when the comm box should appear and disappear
+    /// 1 - Automatic, the streamer can set two input time values and the comm box handles the blending automatically
+    /// </summary>
+    public int DisplayMode { get; set; } = (int)CommBoxDisplayMode.Manual;
 }

Backend/DSB.StreamBackend/Enums/CommBoxDisplayMode.cs

@@ -0,0 +1,7 @@
+namespace DSB.StreamBackend.Enums;
+
+public enum CommBoxDisplayMode
+{
+    Manual,
+    Automatic
+}

Backend/DSB.StreamBackend/Hubs/EventHub.cs

@@ -0,0 +1,37 @@
+using Microsoft.AspNetCore.SignalR;
+
+namespace DSB.StreamBackend.Hubs;
+
+/// <summary>
+/// A SignalR hub for event clients.
+/// </summary>
+/// <remarks>
+/// This hub provides a communication channel for streaming event clients
+/// to receive real-time updates from the backend.
+/// </remarks>
+public class EventHub : Hub<IEventClient>
+{
+    /// <summary>
+    /// Notifies all clients of a commentator box hide event when it gets invoked from the client
+    /// </summary>
+    public async Task CommBoxHideButtonClicked()
+    {
+        await Clients.All.CommBoxHideButtonClicked();
+    }
+
+    /// <summary>
+    /// Notifies all clients of a commentator box show event when it gets invoked from the client
+    /// </summary>
+    public async Task CommBoxShowButtonClicked()
+    {
+        await Clients.All.CommBoxShowButtonClicked();
+    }
+
+    /// <summary>
+    /// Notifies all clients of a commentator box show temp event when it gets invoked from the client
+    /// </summary>
+    public async Task CommBoxShowTempButtonClicked()
+    {
+        await Clients.All.CommBoxShowTempButtonClicked();
+    }
+}

Backend/DSB.StreamBackend/Hubs/IEventClient.cs

@@ -0,0 +1,22 @@
+namespace DSB.StreamBackend.Hubs;
+
+/// <summary>
+/// Defines client-side event callbacks that can be invoked from the server.
+/// </summary>
+public interface IEventClient
+{
+    /// <summary>
+    /// Sends the button click event that hides the commentator box to connected event clients.
+    /// </summary>
+    Task CommBoxHideButtonClicked();
+
+    /// <summary>
+    /// Sends the button click event that shows the commentator box to connected event clients.
+    /// </summary>
+    Task CommBoxShowButtonClicked();
+
+    /// <summary>
+    /// Sends the button click event that shows the commentator box temporarily to connected event clients.
+    /// </summary>
+    Task CommBoxShowTempButtonClicked();
+}

Backend/DSB.StreamBackend/Migrations/20260620151217_AddWeek.cs

@@ -31,6 +31,12 @@ protected override void Up(MigrationBuilder migrationBuilder)
                     table.PrimaryKey("PK_Socials", x => x.Id);
                 });
 
+            migrationBuilder.InsertData(
+                table: "Socials",
+                columns: new[] { "Id", "XHandle", "DiscordInvite" },
+                values: new object[] { 1, string.Empty, string.Empty }
+            );
+
             migrationBuilder.UpdateData(
                 table: "BroadcastStates",
                 keyColumn: "Id",

Backend/DSB.StreamBackend/Migrations/20260623051911_AddCommentatorBoxTimeData.cs

@@ -23,6 +23,12 @@ protected override void Up(MigrationBuilder migrationBuilder)
                 {
                     table.PrimaryKey("PK_CommentatorBoxTimeData", x => x.Id);
                 });
+
+            migrationBuilder.InsertData(
+                table: "CommentatorBoxTimeData",
+                columns: new[] { "Id", "ShowDisplayIntervalInSeconds", "HideDisplayIntervalInSeconds" },
+                values: new object[] { 1, 5, 50 }
+            );
         }
 
         /// <inheritdoc />