Develop/feature/td 5829 5862 shared architecture and bff 2

.gitignore

@@ -56,3 +56,8 @@ obj
 /AdminUI/LearningHub.Nhs.AdminUI/web.config
 /LearningHub.Nhs.WebUI/web.config
 /WebAPI/LearningHub.Nhs.API/web.config
+/LearningHub.Nhs.WebUI/nuget.config
+/LearningHub.Nhs.WebUI.BlazorClient/Properties/launchSettings.json
+/LearningHub.Nhs.WebUI.BlazorClient/wwwroot/appsettings.json
+/LearningHub.Nhs.WebUI.BlazorClient/wwwroot/appsettings.Development.json
+/LearningHub.Nhs.WebUI.BlazorClient/nuget.config

LearningHub.Nhs.WebUI/Configuration/FindwiseSettings.cs → LearningHub.Nhs.Shared/Configuration/ExposableFindwiseSettings.cs

@@ -1,9 +1,15 @@
-namespace LearningHub.Nhs.WebUI.Configuration
+namespace LearningHub.Nhs.Shared.Configuration
 {
+    using LearningHub.Nhs.Shared.Interfaces.Configuration;
     /// <summary>
-    /// Defines the <see cref="FindwiseSettings" />.
+    /// Represents a public-facing set of configuration values for Findwise search,
+    /// intended to be safely exposed to client-side applications or public APIs.
+    /// 
+    /// <para>
+    /// Contains only non-sensitive data such as page sizes for various search types.
+    /// </para>
     /// </summary>
-    public class FindwiseSettings
+    public class ExposableFindwiseSettings : IExposableFindwiseSettings
     {
         /// <summary>
         /// Gets or sets the ResourceSearchPageSize.

LearningHub.Nhs.Shared/Configuration/ExposableSettings.cs

@@ -0,0 +1,36 @@
+namespace LearningHub.Nhs.Shared.Configuration
+{
+    using LearningHub.Nhs.Shared.Interfaces.Configuration;
+    /// <summary>
+    /// Represents configuration values that are safe to expose to clientside frontend applications
+    /// (such as Blazor WebAssembly) or public-facing APIs.
+    /// 
+    /// <para>
+    /// Implements <see cref="IExposableSettings"/> and contains only non-sensitive, non-secret
+    /// values such as public API endpoints and pagination settings. This separation ensures
+    /// that secure or private configuration data is not inadvertently exposed to clients.
+    /// </para>
+    /// </summary>
+    public class ExposableSettings : IExposableSettings
+    {
+        /// <inheritdoc/>
+        public string LearningHubApiUrl { get; set; }
+
+        /// <summary>
+        /// Gets or sets the UserApiUrl.
+        /// </summary>
+        public string UserApiUrl { get; set; }
+
+        /// <summary>
+        /// Gets or sets the OpenApiUrl.
+        /// </summary>
+        public string OpenApiUrl { get; set; }
+        /// <summary>
+        /// Backend for Frontend (BFF) URL for the Learning Hub API accessed by samesite cookie and uses httpclients with bearers to access external apis.
+        /// </summary>
+        public string LearningHubApiBFFUrl { get; set; }
+        /// <inheritdoc/>
+        public IExposableFindwiseSettings FindwiseSettings { get; set; }
+
+    }
+}

LearningHub.Nhs.Shared/Helpers/FormattingHelper.cs

@@ -0,0 +1,61 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace LearningHub.Nhs.Shared.Helpers
+{
+    public static class FormattingHelper
+    {
+
+        /// <summary>
+        /// Returns a number of milliseconds converted into a duration string, such as "10 min 15 sec". Includes rounding to match the behaviour of the Azure Media Player.
+        /// </summary>
+        /// <param name="durationInMilliseconds">The number of milliseconds.</param>
+        /// <returns>The duration string.</returns>
+        public static string GetDurationText(int durationInMilliseconds)
+        {
+            if (durationInMilliseconds > 0)
+            {
+                // Azure media player rounds duration to nearest second. e.g. 8:59.88 becomes 9:00. LH needs to match.
+                int nearestSecond = (int)Math.Round(((double)durationInMilliseconds) / 1000);
+                var duration = new TimeSpan(0, 0, nearestSecond);
+                string returnValue = string.Empty;
+
+                // If duration greater than an hour, don't return the seconds part.
+                if (duration.Hours > 0)
+                {
+                    returnValue = $"{duration.Hours} hr {duration.Minutes} min ";
+
+                    // Exclude "0 min" from the return value.
+                    if (returnValue.EndsWith(" 0 min "))
+                    {
+                        returnValue = returnValue.Replace("0 min ", string.Empty);
+                    }
+                }
+                else
+                {
+                    returnValue = $"{duration.Minutes} min {duration.Seconds} sec ";
+
+                    // Exclude "0 min" and "0 sec" from the return value.
+                    if (returnValue.StartsWith("0 min "))
+                    {
+                        returnValue = returnValue.Replace("0 min ", string.Empty);
+                    }
+
+                    if (returnValue.EndsWith(" 0 sec "))
+                    {
+                        returnValue = returnValue.Replace("0 sec ", string.Empty);
+                    }
+                }
+
+                return returnValue;
+            }
+            else
+            {
+                return string.Empty;
+            }
+        }
+    }
+}

LearningHub.Nhs.Shared/Helpers/MoodleHelper.cs

@@ -0,0 +1,115 @@
+using LearningHub.Nhs.Models.Enums;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace LearningHub.Nhs.Shared.Helpers
+{
+    public static class MoodleHelper
+    {
+        /// TODO: Remove this method after adding to Moodle resource types to models project.
+        /// <summary>
+        /// Returns a prettified resource type name, suitable for display in the UI. Includes video/audio duration string.
+        /// </summary>
+        /// <param name="resourceType">The resource type.</param>
+        /// <param name="durationInMilliseconds">The media duration in milliseconds.</param>
+        /// <returns>The resource type name, and duration if applicable.</returns>
+        public static string GetPrettifiedResourceTypeNameMoodle(ResourceTypeEnum resourceType, int? durationInMilliseconds = 0)
+        {
+            switch (resourceType)
+            {
+                case ResourceTypeEnum.Assessment:
+                    return "Assessment";
+                case ResourceTypeEnum.Article:
+                    return "Article";
+                case ResourceTypeEnum.Audio:
+                    string durationText = FormattingHelper.GetDurationText(durationInMilliseconds ?? 0);
+                    durationText = string.IsNullOrEmpty(durationText) ? string.Empty : " - " + durationText;
+                    return "Audio" + durationText;
+                case ResourceTypeEnum.Equipment:
+                    return "Equipment";
+                case ResourceTypeEnum.Image:
+                    return "Image";
+                case ResourceTypeEnum.Scorm:
+                    return "elearning";
+                case ResourceTypeEnum.Video:
+                    durationText = FormattingHelper.GetDurationText(durationInMilliseconds ?? 0);
+                    durationText = string.IsNullOrEmpty(durationText) ? string.Empty : " - " + durationText;
+                    return "Video" + durationText;
+                case ResourceTypeEnum.WebLink:
+                    return "Web link";
+                case ResourceTypeEnum.GenericFile:
+                    return "File";
+                case ResourceTypeEnum.Embedded:
+                    return "Embedded";
+                case ResourceTypeEnum.Case:
+                    return "Case";
+                case ResourceTypeEnum.Html:
+                    return "HTML";
+                case ResourceTypeEnum.Moodle:
+                    return "Course";
+                default:
+                    return "File";
+            }
+        }
+
+        /// TODO: Remove this method after adding to Moodle resource types to models project.
+        /// <summary>
+        /// Findwise Moodle resource type dictionary.
+        /// </summary>
+        public static readonly Dictionary<string, ResourceTypeEnum> FindwiseResourceMoodleTypeDict = new Dictionary<string, ResourceTypeEnum>()
+        {
+            { "video", ResourceTypeEnum.Video },
+            { "article", ResourceTypeEnum.Article },
+            { "case", ResourceTypeEnum.Case },
+            { "weblink", ResourceTypeEnum.WebLink },
+            { "audio", ResourceTypeEnum.Audio },
+            { "scorm", ResourceTypeEnum.Scorm },
+            { "assessment", ResourceTypeEnum.Assessment },
+            { "genericfile", ResourceTypeEnum.GenericFile },
+            { "image", ResourceTypeEnum.Image },
+            { "html", ResourceTypeEnum.Html },
+            { "moodle", ResourceTypeEnum.Moodle },
+        };
+
+        /// <summary>
+        /// Returns a prettified resource type name, suitable for display in the UI. Excludes video/audio duration string.
+        /// </summary>
+        /// <param name="resourceType">The resource type.</param>
+        /// <returns>The resource type name, and duration if applicable.</returns>
+        public static string GetPrettifiedResourceTypeName(ResourceTypeEnum resourceType)
+        {
+            switch (resourceType)
+            {
+                case ResourceTypeEnum.Assessment:
+                    return "Assessment";
+                case ResourceTypeEnum.Article:
+                    return "Article";
+                case ResourceTypeEnum.Audio:
+                    return "Audio";
+                case ResourceTypeEnum.Equipment:
+                    return "Equipment";
+                case ResourceTypeEnum.Image:
+                    return "Image";
+                case ResourceTypeEnum.Scorm:
+                    return "elearning";
+                case ResourceTypeEnum.Video:
+                    return "Video";
+                case ResourceTypeEnum.WebLink:
+                    return "Web link";
+                case ResourceTypeEnum.GenericFile:
+                    return "File";
+                case ResourceTypeEnum.Embedded:
+                    return "Embedded";
+                case ResourceTypeEnum.Case:
+                    return "Case";
+                case ResourceTypeEnum.Html:
+                    return "HTML";
+                default:
+                    return "File";
+            }
+        }
+    }
+}

LearningHub.Nhs.WebUI/Helpers/ResourceAccessLevelHelper.cs → LearningHub.Nhs.Shared/Helpers/ResourceAccessLevelHelper.cs

@@ -1,7 +1,6 @@
-namespace LearningHub.Nhs.WebUI.Helpers
+namespace LearningHub.Nhs.Shared.Helpers
 {
     using LearningHub.Nhs.Models.Enums;
-    using Microsoft.AspNetCore.Mvc.Rendering;
 
     /// <summary>
     /// Defines the <see cref="ResourceAccessLevelHelper" />.
@@ -11,7 +10,7 @@ public static class ResourceAccessLevelHelper
         /// <summary>
         /// Get resource access level text.
         /// </summary>
-        /// <param name="resourceAccessibilityEnum">The htmlhelper<see cref="IHtmlHelper"/>.</param>
+        /// <param name="resourceAccessibilityEnum">The enum value to get display text for.</param>
         /// <returns>The <see cref="string"/>.</returns>
         public static string GetResourceAccessLevelText(this ResourceAccessibilityEnum resourceAccessibilityEnum)
         {

LearningHub.Nhs.WebUI/Helpers/ResourceTypeEnumMoodle.cs → LearningHub.Nhs.Shared/Helpers/ResourceTypeEnumMoodle.cs

@@ -1,4 +1,4 @@
-namespace LearningHub.Nhs.WebUI.Helpers;
+namespace LearningHub.Nhs.Shared.Helpers;
 
 /// <summary>
 /// Represents the types of resources available in Moodle.

LearningHub.Nhs.WebUI/Helpers/SearchHelper.cs → LearningHub.Nhs.Shared/Helpers/SearchHelper.cs

@@ -1,4 +1,4 @@
-namespace LearningHub.Nhs.WebUI.Helpers
+namespace LearningHub.Nhs.Shared.Helpers
 {
     using System.Collections.Generic;
     using LearningHub.Nhs.Models.Enums;

LearningHub.Nhs.Shared/Interfaces/Configuration/IExposableFindwiseSettings.cs

@@ -0,0 +1,29 @@
+namespace LearningHub.Nhs.Shared.Interfaces.Configuration
+{
+    /// <summary>
+    /// Represents configuration values related to Findwise search that are safe to expose
+    /// to client-side applications or public-facing APIs.
+    /// 
+    /// <para>
+    /// This includes non-sensitive values such as page sizes for different types of search results.
+    /// It does not contain any secure credentials or internal service configuration.
+    /// </para>
+    /// </summary>
+    public interface IExposableFindwiseSettings
+    {
+        /// <summary>
+        /// Gets or sets the page size for resource search results.
+        /// </summary>
+        public int ResourceSearchPageSize { get; set; }
+
+        /// <summary>
+        /// Gets or sets the CatalogueSearchPageSize.
+        /// </summary>
+        public int CatalogueSearchPageSize { get; set; }
+
+        /// <summary>
+        /// Gets or sets the AllCatalogueSearchPageSize.
+        /// </summary>
+        public int AllCatalogueSearchPageSize { get; set; }
+    }
+}

LearningHub.Nhs.Shared/Interfaces/Configuration/IExposableSettings.cs

@@ -0,0 +1,42 @@
+namespace LearningHub.Nhs.Shared.Interfaces.Configuration
+{
+    /// <summary>
+    /// Defines a contract for configuration data that is non-sensitive and safe to expose publicly
+    ///
+    /// <para>
+    /// This interface exposes only data that is safe to be publicly consumed or shared,
+    /// such as API endpoint URLs or non-sensitive configuration values.
+    /// It explicitly excludes any private or sensitive information (e.g., authentication tokens,
+    /// credentials, or secret keys), which should be handled via separate interfaces or services.
+    /// </para>
+    ///
+    /// <para>
+    /// The data provided by this interface can be safely used in frontend technologies,
+    /// such as Blazor WebAssembly, JavaScript frameworks, or other client-side applications,
+    /// without risking exposure of sensitive information.
+    /// </para>
+    /// </summary>
+    public interface IExposableSettings
+    {
+        /// <summary>
+        /// Gets or sets the LearningHubApiUrl.
+        /// </summary>
+        public string LearningHubApiUrl { get; set; }
+
+        /// <summary>
+        /// Gets or sets the UserApiUrl.
+        /// </summary>
+        public string UserApiUrl { get; set; }
+
+        /// <summary>
+        /// Gets or sets the OpenApiUrl.
+        /// </summary>
+        public string OpenApiUrl { get; set; }
+        /// <summary>
+        /// Gets or sets the LearningHubApiBFFUrl used to proxy via same domain cookie to the BFF LearningHubAPI calls.
+        /// </summary>
+        public string LearningHubApiBFFUrl { get; set; }
+
+        public IExposableFindwiseSettings FindwiseSettings { get; set; }
+    }
+}

LearningHub.Nhs.Shared/Interfaces/Http/IAPIHttpClient.cs

@@ -0,0 +1,18 @@
+namespace LearningHub.Nhs.Shared.Interfaces.Http
+{
+    /// <summary>
+    /// Represents an HTTP client for a specific API.
+    /// </summary>
+    public interface IAPIHttpClient
+    {
+        /// <summary>
+        /// Gets the configured <see cref="HttpClient"/> for the API.
+        /// </summary>
+        Task<HttpClient> GetClientAsync();
+
+        /// <summary>
+        /// Gets the base URL of the API.
+        /// </summary>
+        string ApiUrl { get; }
+    }
+}

LearningHub.Nhs.Shared/Interfaces/Http/ILearningHubHttpClient.cs

@@ -0,0 +1,22 @@
+namespace LearningHub.Nhs.Shared.Interfaces.Http
+{
+    /// <summary>
+    /// Marker interface for the LearningHub API HttpClient.
+    ///
+    /// <para>
+    /// Inherits from <see cref="IAPIHttpClient"/> to enable
+    /// dependency injection of a specific implementation configured with
+    /// different API endpoints or settings specific to LH API.
+    /// </para>
+    ///
+    /// <para>
+    /// Currently, this interface is empty and used solely to differentiate implementations
+    /// that connect to different endpoints via configuration, but it may be extended in the future
+    /// with LearningHub-specific functionality or properties.
+    /// </para>
+    /// </summary>
+    public interface ILearningHubHttpClient : IAPIHttpClient
+    {
+
+    }
+}