Merge pull request #1168 from TechnologyEnhancedLearning/Develop/Fixes/Open-API-fixes

Merge Develop/Fixes/Open-API-fixes to RC -LH EnglishlIvy 1.3.1-Open API Changes

Author: AnjuJose011

OpenAPI/LearningHub.Nhs.OpenApi.Models/Configuration/LearningHubConfig.cs

@@ -55,5 +55,75 @@ public class LearningHubConfig
         /// </summary>
         public string ResourcePublishQueueRouteName { get; set; } = null!;
 
+        /// <summary>
+        /// Gets or sets <see cref="Notifications"/>.
+        /// </summary>
+        public NotificationSetting Notifications { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="MyContributionsUrl"/>.
+        /// </summary>
+        public string MyContributionsUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="MyLearningUrl"/>.
+        /// </summary>
+        public string MyLearningUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="MyBookmarksUrl"/>.
+        /// </summary>
+        public string MyBookmarksUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="SearchUrl"/>.
+        /// </summary>
+        public string SearchUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="AdminUrl"/>.
+        /// </summary>
+        public string AdminUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="ForumsUrl"/>.
+        /// </summary>
+        public string ForumsUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="HelpUrl"/>.
+        /// </summary>
+        public string HelpUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="MyRecordsUrl"/>.
+        /// </summary>
+        public string MyRecordsUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="NotificationsUrl"/>.
+        /// </summary>
+        public string NotificationsUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="RegisterUrl"/>.
+        /// </summary>
+        public string RegisterUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="SignOutUrl"/>.
+        /// </summary>
+        public string SignOutUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="MyAccountUrl"/>.
+        /// </summary>
+        public string MyAccountUrl { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets <see cref="BrowseCataloguesUrl"/>.
+        /// </summary>
+        public string BrowseCataloguesUrl { get; set; } = null!;
+
     }
 }

OpenAPI/LearningHub.Nhs.OpenApi.Models/Configuration/NotificationSetting.cs

@@ -0,0 +1,59 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace LearningHub.Nhs.OpenApi.Models.Configuration
+{
+    /// <summary>
+    /// Gets or sets NotificationSetting.
+    /// </summary>
+    public class NotificationSetting
+    {
+        /// <summary>
+        /// Gets or sets the PublishResourceTimeToProcessInSec.
+        /// </summary>
+        public int PublishResourceTimeToProcessInSec { get; set; }
+
+        /// <summary>
+        /// Gets or sets the ResourcePublishedTitle.
+        /// </summary>
+        public string ResourcePublishedTitle { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the ResourcePublished.
+        /// </summary>
+        public string ResourcePublished { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the ResourcePublishFailedTitle.
+        /// </summary>
+        public string ResourcePublishFailedTitle { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the ResourcePublishFailed.
+        /// </summary>
+        public string ResourcePublishFailed { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the ResourcePublishFailedWithReason.
+        /// </summary>
+        public string ResourcePublishFailedWithReason { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the ResourceAccessTitle.
+        /// </summary>
+        public string ResourceAccessTitle { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the ResourceReadonlyAccess.
+        /// </summary>
+        public string ResourceReadonlyAccess { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the ResourceContributeAccess.
+        /// </summary>
+        public string ResourceContributeAccess { get; set; } = null!;
+    }
+}

OpenAPI/LearningHub.Nhs.OpenApi.Models/ViewModels/NavigationModel.cs

@@ -0,0 +1,78 @@
+namespace LearningHub.Nhs.OpenApi.Models.ViewModels
+{
+    /// <summary>
+    /// Defines the <see cref="NavigationModel" />.
+    /// </summary>
+    public class NavigationModel
+    {
+        /// <summary>
+        /// Gets or sets the NotificationCount.
+        /// </summary>
+        public int NotificationCount { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowAdmin.
+        /// </summary>
+        public bool ShowAdmin { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowForums.
+        /// </summary>
+        public bool ShowForums { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowHelp.
+        /// </summary>
+        public bool ShowHelp { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowMyContributions.
+        /// </summary>
+        public bool ShowMyContributions { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowMyLearning.
+        /// </summary>
+        public bool ShowMyLearning { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowMyBookmarks.
+        /// </summary>
+        public bool ShowMyBookmarks { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowSearch.
+        /// </summary>
+        public bool ShowSearch { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowMyRecords.
+        /// </summary>
+        public bool ShowMyRecords { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowNotifications.
+        /// </summary>
+        public bool ShowNotifications { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowRegister.
+        /// </summary>
+        public bool ShowRegister { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ShowSignOut.
+        /// </summary>
+        public bool ShowSignOut { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to show my account.
+        /// </summary>
+        public bool ShowMyAccount { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to show Browse Catalogues.
+        /// </summary>
+        public bool ShowBrowseCatalogues { get; set; }
+    }
+}

OpenAPI/LearningHub.Nhs.OpenApi.Repositories.Interface/Repositories/INotificationRepository.cs

@@ -0,0 +1,25 @@
+namespace LearningHub.Nhs.OpenApi.Repositories.Interface.Repositories
+{
+    using System.Linq;
+    using System.Threading.Tasks;
+    using LearningHub.Nhs.Models.Entities;
+
+    /// <summary>
+    /// The NotificationRepository interface.
+    /// </summary>
+    public interface INotificationRepository : IGenericRepository<Notification>
+    {
+        /// <summary>
+        /// The get by id async.
+        /// </summary>
+        /// <param name="id">The id.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<Notification> GetByIdAsync(int id);
+
+        /// <summary>
+        /// The get all full.
+        /// </summary>
+        /// <returns>The <see cref="IQueryable"/>.</returns>
+        IQueryable<Notification> GetAllFull();
+    }
+}

OpenAPI/LearningHub.Nhs.OpenApi.Repositories.Interface/Repositories/IResourceRepository.cs

@@ -72,5 +72,12 @@ Task<IEnumerable<ResourceReference>> GetResourceReferencesByOriginalResourceRefe
         /// <returns>The <see cref="Task"/>.</returns>
         Task<Resource> GetByResourceVersionIdAsync(int resourceVersionId);
 
+        /// <summary>
+        /// Returns a bool to indicate if the resourceVersionId corresponds to a current version of a resource.
+        /// </summary>
+        /// <param name="resourceVersionId">The resourceVersionId.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<bool> IsCurrentVersionAsync(int resourceVersionId);
+
     }
 }

OpenAPI/LearningHub.Nhs.OpenApi.Repositories.Interface/Repositories/IUserNotificationRepository.cs

@@ -0,0 +1,45 @@
+namespace LearningHub.Nhs.OpenApi.Repositories.Interface.Repositories
+{
+    using System.Linq;
+    using System.Threading.Tasks;
+    using LearningHub.Nhs.Models.Entities;
+    using LearningHub.Nhs.Models.Enums;
+
+    /// <summary>
+    /// The UserNotificationRepository interface.
+    /// </summary>
+    public interface IUserNotificationRepository : IGenericRepository<UserNotification>
+    {
+        /// <summary>
+        /// The get by id async.
+        /// </summary>
+        /// <param name="id">The id.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<UserNotification> GetByIdAsync(int id);
+
+        /// <summary>
+        /// The get by notification and user id async.
+        /// </summary>
+        /// <param name="userId">The user id.</param>
+        /// <param name="notificationId">The notification id.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<UserNotification> GetByNotificationAndUserIdAsync(int userId, int notificationId);
+
+        /// <summary>
+        /// The get user unread notification count async.
+        /// </summary>
+        /// <param name="userid">The userid.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<int> GetUserUnreadNotificationCountAsync(int userid);
+
+        /// <summary>
+        /// The get all non dismissed.
+        /// </summary>
+        /// <param name="userId">The user id.</param>
+        /// <param name="priorityType">Notification priority type.</param>
+        /// <param name="sortColumn">The sort column.</param>
+        /// <param name="sortDirection">The sort direction.</param>
+        /// <returns>The <see cref="IQueryable"/>.</returns>
+        IQueryable<UserSpecificNotification> GetAllNonDismissed(int userId, NotificationPriorityEnum priorityType, string sortColumn = "", string sortDirection = "");
+    }
+}

OpenAPI/LearningHub.Nhs.OpenApi.Repositories.Interface/Repositories/Resources/IResourceSyncRepository.cs

@@ -0,0 +1,44 @@
+namespace LearningHub.Nhs.OpenApi.Repositories.Interface.Repositories.Resources
+{
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Threading.Tasks;
+    using LearningHub.Nhs.Models.Entities.Resource;
+
+    /// <summary>
+    /// The IResourceSyncRepository.
+    /// </summary>
+    public interface IResourceSyncRepository
+    {
+        /// <summary>
+        /// The GetSyncListForUser.
+        /// </summary>
+        /// <param name="userId">The userid.</param>
+        /// <param name="includeResources">If the resource property should be populated.</param>
+        /// <returns>The sync list for the user.</returns>
+        IQueryable<ResourceSync> GetSyncListForUser(int userId, bool includeResources);
+
+        /// <summary>
+        /// The AddToSyncListAsync.
+        /// </summary>
+        /// <param name="userId">The userId.</param>
+        /// <param name="resourceIds">The resourceIds.</param>
+        /// <returns>The task.</returns>
+        Task AddToSyncListAsync(int userId, List<int> resourceIds);
+
+        /// <summary>
+        /// The RemoveFromSyncListAsync.
+        /// </summary>
+        /// <param name="userId">The userId.</param>
+        /// <param name="resourceIds">The resourceIds.</param>
+        /// <returns>The task.</returns>
+        Task RemoveFromSyncListAsync(int userId, List<int> resourceIds);
+
+        /// <summary>
+        /// The SetSyncedForUserAsync.
+        /// </summary>
+        /// <param name="userId">The userId.</param>
+        /// <returns>The task.</returns>
+        Task SetSyncedForUserAsync(int userId);
+    }
+}

OpenAPI/LearningHub.Nhs.OpenApi.Repositories.Interface/Repositories/Resources/IResourceVersionRatingRepository.cs

@@ -0,0 +1,26 @@
+namespace LearningHub.Nhs.OpenApi.Repositories.Interface.Repositories.Resources
+{
+    using System.Threading.Tasks;
+    using LearningHub.Nhs.Models.Entities.Resource;
+
+    /// <summary>
+    /// The ResourceVersionEventRepository interface.
+    /// </summary>
+    public interface IResourceVersionRatingRepository : IGenericRepository<ResourceVersionRating>
+    {
+        /// <summary>
+        /// Gets a user's previous rating for any minor version of the current major resource version.
+        /// </summary>
+        /// <param name="resourceVersionId">The resourceVersionId.</param>
+        /// <param name="userId">The userId.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<ResourceVersionRating> GetUsersPreviousRatingForSameMajorVersionAsync(int resourceVersionId, int userId);
+
+        /// <summary>
+        /// Gets the total rating counts for a particular resource version PLUS all other minor versions of the same major version.
+        /// </summary>
+        /// <param name="resourceVersionId">The resourceVersionId.</param>
+        /// <returns>An array of integers, which are the count for each star value, starting at 1 star and ending with 5 stars.</returns>
+        Task<int[]> GetRatingCountsForResourceVersionAsync(int resourceVersionId);
+    }
+}

OpenAPI/LearningHub.Nhs.OpenApi.Repositories.Interface/Repositories/Resources/IResourceVersionRatingSummaryRepository.cs

@@ -0,0 +1,18 @@
+namespace LearningHub.Nhs.OpenApi.Repositories.Interface.Repositories.Resources
+{
+    using System.Threading.Tasks;
+    using LearningHub.Nhs.Models.Entities.Resource;
+
+    /// <summary>
+    /// The ResourceVersionEventRepository interface.
+    /// </summary>
+    public interface IResourceVersionRatingSummaryRepository : IGenericRepository<ResourceVersionRatingSummary>
+    {
+        /// <summary>
+        /// The get by resource version id async.
+        /// </summary>
+        /// <param name="resourceVersionId">The resource version id.</param>
+        /// <returns>The <see cref="Task"/>.</returns>
+        Task<ResourceVersionRatingSummary> GetByResourceVersionIdAsync(int resourceVersionId);
+    }
+}