feat: add rest list control, general improvements and minor bugs

Author: ReneSchwarzer

src/WebUI/Model/Game.cs

@@ -0,0 +1,39 @@
+using System;
+using WebExpress.WebApp.WebAttribute;
+using WebExpress.WebIndex;
+
+namespace WebExpress.Tutorial.WebUI.Model
+{
+    /// <summary>
+    /// Represents a Monkey Island game entry.
+    /// </summary>
+    public class Game : IIndexItem
+    {
+        /// <summary>
+        /// The unique identifier of the game.
+        /// </summary>
+        [RestListHidden()]
+        public Guid Id { get; set; } = Guid.NewGuid();
+
+        /// <summary>
+        /// The title of the game.
+        /// </summary>
+        [RestListPrimary("Name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// The release year of the game.
+        /// </summary>
+        public int ReleaseYear { get; set; }
+
+        /// <summary>
+        /// A short description of the game.
+        /// </summary>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Indicates whether the game is a remake or original.
+        /// </summary>
+        public bool IsRemake { get; set; }
+    }
+}

src/WebUI/Model/ViewModel.cs

@@ -15,12 +15,17 @@ public static class ViewModel
         /// <summary>
         /// Returns the list of inventories available in Monkey Island.
         /// </summary>
-        public static List<Inventory> MonkeyIslanInventories { get; } = [.. GetMonkeyIslandInventories()];
+        public static List<Inventory> MonkeyIslandInventories { get; } = [.. GetMonkeyIslandInventories()];
 
         /// <summary>
         /// Returns the list of predefined locations in Monkey Island.
         /// </summary>
-        public static List<Location> MonkeyIslanLocations { get; } = [.. GetMonkeyIslandLocations()];
+        public static List<Location> MonkeyIslandLocations { get; } = [.. GetMonkeyIslandLocations()];
+
+        /// <summary>
+        /// Returns a list of Monkey Island games.
+        /// </summary>
+        public static List<Game> MonkeyIslandGames { get; } = [.. GetMonkeyIslandGames()];
 
         /// <summary>
         /// Retrieves a collection of characters from the Monkey Island universe.
@@ -706,7 +711,77 @@ public static IEnumerable<Location> GetMonkeyIslandLocations()
                 Description = "The dread pirate's vessel anchored in hidden waters.",
                 Island = "Monkey Island"
             };
+        }
+
+        /// <summary>
+        /// Retrieves a collection of Monkey Island games.
+        /// </summary>
+        /// <returns>A collection containing the games.</returns>
+        public static IEnumerable<Game> GetMonkeyIslandGames()
+        {
+            yield return new Game
+            {
+                Name = "The Secret of Monkey Island",
+                ReleaseYear = 1990,
+                Description = "Guybrush Threepwood begins his pirate journey on Mêlée Island and faces the ghost pirate LeChuck.",
+                IsRemake = false
+            };
+
+            yield return new Game
+            {
+                Name = "Monkey Island 2: LeChuck’s Revenge",
+                ReleaseYear = 1991,
+                Description = "Guybrush searches for the legendary treasure Big Whoop while LeChuck returns as a zombie.",
+                IsRemake = false
+            };
+
+            yield return new Game
+            {
+                Name = "The Curse of Monkey Island",
+                ReleaseYear = 1997,
+                Description = "Guybrush must lift a curse from Elaine and defeat LeChuck once again, now in skeletal form.",
+                IsRemake = false
+            };
+
+            yield return new Game
+            {
+                Name = "Escape from Monkey Island",
+                ReleaseYear = 2000,
+                Description = "Guybrush battles corporate villain Ozzie Mandrill to save the pirate way of life.",
+                IsRemake = false
+            };
 
+            yield return new Game
+            {
+                Name = "Tales of Monkey Island",
+                ReleaseYear = 2009,
+                Description = "Episodic adventure where Guybrush accidentally unleashes a voodoo plague and must stop it.",
+                IsRemake = false
+            };
+
+            yield return new Game
+            {
+                Name = "Return to Monkey Island",
+                ReleaseYear = 2022,
+                Description = "Guybrush finally uncovers the true secret of Monkey Island in a modern, stylized adventure.",
+                IsRemake = false
+            };
+
+            yield return new Game
+            {
+                Name = "The Secret of Monkey Island: Special Edition",
+                ReleaseYear = 2009,
+                Description = "Remake of the original with updated graphics, voice acting, and music.",
+                IsRemake = true
+            };
+
+            yield return new Game
+            {
+                Name = "Monkey Island 2: LeChuck’s Revenge – Special Edition",
+                ReleaseYear = 2010,
+                Description = "Remake of the second game with enhanced visuals and audio, plus commentary.",
+                IsRemake = true
+            };
         }
     }
 }

src/WebUI/WWW/Api/1/MonkeyIslandCharacters.cs

@@ -45,20 +45,20 @@ public MonkeyIslandCharacters(ISitemapManager sitemapManager, IApplicationContex
         /// </summary>
         /// <param name="request">The request object containing the criteria for retrieving options. Cannot be null.</param>
         /// <param name="row">The row object for which options are being retrieved. Cannot be null.</param>
-        public override IEnumerable<RestApiCrudTableRowOption> GetOptions(Request request, Character row)
+        public override IEnumerable<RestApiCrudOption> GetOptions(Request request, Character row)
         {
-            yield return new RestApiCrudTableRowOptionHeader(request)
+            yield return new RestApiCrudOptionHeader(request)
             {
                 Label = "webexpress.webapp:header.setting.label"
             };
 
-            yield return new RestApiCrudTableRowOptionEdit(request)
+            yield return new RestApiCrudOptionEdit(request)
             {
                 Uri = _formUri
             };
 
-            yield return new RestApiCrudTableRowOptionSeperator(request);
-            yield return new RestApiCrudTableRowOptionDelete(request);
+            yield return new RestApiCrudOptionSeperator(request);
+            yield return new RestApiCrudOptionDelete(request);
         }
 
         /// <summary>

src/WebUI/WWW/Api/1/MonkeyIslandGames.cs

@@ -0,0 +1,100 @@
+using System.Collections.Generic;
+using System.Linq;
+using WebExpress.Tutorial.WebUI.Model;
+using WebExpress.Tutorial.WebUI.WWW.Controls;
+using WebExpress.WebApp.WebRestApi;
+using WebExpress.WebCore.WebApplication;
+using WebExpress.WebCore.WebAttribute;
+using WebExpress.WebCore.WebMessage;
+using WebExpress.WebCore.WebRestApi;
+using WebExpress.WebCore.WebSitemap;
+
+namespace WebExpress.Tutorial.WebUI.WWW.Api._1
+{
+    /// <summary>
+    /// Represents a REST API table for managing and retrieving data about Monkey Island games.
+    /// </summary>
+    [Title("Monkey Island Games")]
+    [Method(CrudMethod.GET)]
+    [Method(CrudMethod.DELETE)]
+    [Method(CrudMethod.PUT)]
+    public sealed class MonkeyIslandGames : RestApiCrudList<Game>
+    {
+        private readonly string _formUri;
+
+        /// <summary>
+        /// Initializes a new instance of the class.
+        /// </summary>
+        /// <param name="sitemapManager">The sitemap manager used to retrieve URIs for the application context.</param>
+        /// <param name="applicationContext">The application context containing the current state of the application.</param>
+        public MonkeyIslandGames(ISitemapManager sitemapManager, IApplicationContext applicationContext)
+        {
+            var uri = sitemapManager.GetUri<RestList>(applicationContext);
+            _formUri = uri?.SetFragment("myListForm")?.ToString();
+
+            Data = ViewModel.MonkeyIslandGames;
+        }
+
+        /// <summary>
+        /// Retrieves a collection of options.
+        /// </summary>
+        public override IEnumerable<RestApiCrudOption> GetOptions(Request request, Game row)
+        {
+            yield return new RestApiCrudOptionHeader(request)
+            {
+                Label = "webexpress.webapp:header.setting.label"
+            };
+
+            yield return new RestApiCrudOptionEdit(request)
+            {
+                Uri = _formUri
+            };
+
+            yield return new RestApiCrudOptionSeperator(request);
+            yield return new RestApiCrudOptionDelete(request);
+        }
+
+        /// <summary>
+        /// Retrieves a collection of games based on the specified filter.
+        /// </summary>
+        public override IEnumerable<Game> GetData(string filter, Request request)
+        {
+            if (string.IsNullOrEmpty(filter) || filter == "null")
+            {
+                return Data;
+            }
+
+            return Data.Where(x => x.Name.Contains(filter));
+        }
+
+        /// <summary>
+        /// Performs validation before updating game data.
+        /// </summary>
+        public override RestApiValidationResult ValidateUpdateData(Game item, Request request)
+        {
+            return new RestApiValidator(request)
+                .Require(nameof(Game.Name))
+                .MinLength(nameof(Game.Name), 3)
+                .Require(nameof(Game.ReleaseYear))
+                .Result;
+        }
+
+        /// <summary>
+        /// Updates the game data record.
+        /// </summary>
+        public override void UpdateData(Game item, Request request)
+        {
+            item.Name = request.GetParameter(nameof(Game.Name))?.Value;
+            item.Description = request.GetParameter(nameof(Game.Description))?.Value;
+            item.ReleaseYear = int.TryParse(request.GetParameter(nameof(Game.ReleaseYear))?.Value, out var year) ? year : 0;
+        }
+
+        /// <summary>
+        /// Deletes a game entry.
+        /// </summary>
+        public override void DeleteData(string id, Request request)
+        {
+            ViewModel.MonkeyIslandGames.RemoveAll(x => x.Id.ToString() == id);
+        }
+    }
+}

src/WebUI/WWW/Api/1/MonkeyIslandInventories.cs

@@ -28,7 +28,7 @@ public sealed class MonkeyIslandInventories : RestApiCrudDropdown<Inventory>
         /// </param>
         public MonkeyIslandInventories(ISitemapManager sitemapManager, IApplicationContext applicationContext)
         {
-            Data = ViewModel.MonkeyIslanInventories;
+            Data = ViewModel.MonkeyIslandInventories;
         }
 
         /// <summary>

src/WebUI/WWW/Api/1/MonkeyIslandLocations.cs

@@ -28,7 +28,7 @@ public sealed class MonkeyIslandLocations : RestApiCrudSelection<Location>
         /// </param>
         public MonkeyIslandLocations(ISitemapManager sitemapManager, IApplicationContext applicationContext)
         {
-            Data = ViewModel.MonkeyIslanLocations;
+            Data = ViewModel.MonkeyIslandLocations;
         }
 
         /// <summary>

src/WebUI/WWW/Controls/RestList.cs

@@ -0,0 +1,73 @@
+using WebExpress.Tutorial.WebUI.Model;
+using WebExpress.Tutorial.WebUI.WebControl;
+using WebExpress.Tutorial.WebUI.WebFragment.ControlPage;
+using WebExpress.Tutorial.WebUI.WebPage;
+using WebExpress.Tutorial.WebUI.WebScope;
+using WebExpress.Tutorial.WebUI.WWW.Api._1;
+using WebExpress.WebApp.WebControl;
+using WebExpress.WebApp.WebScope;
+using WebExpress.WebCore.WebAttribute;
+using WebExpress.WebCore.WebPage;
+using WebExpress.WebCore.WebSitemap;
+using WebExpress.WebUI.WebControl;
+
+namespace WebExpress.Tutorial.WebUI.WWW.Controls
+{
+    /// <summary>
+    /// Represents the list control for the tutorial (REST-backed flat list).
+    /// </summary>
+    [Title("RestList")]
+    [Scope<IScopeGeneral>]
+    [Scope<IScopeControl>]
+    [Scope<IScopeControlWebApp>]
+    public sealed class RestList : PageControl
+    {
+        /// <summary>
+        /// Initializes a new instance of the class.
+        /// </summary>
+        /// <param name="pageContext">The context of the page where the list control is used.</param>
+        /// <param name="sitemapManager">The sitemap manager for managing site navigation.</param>
+        public RestList(IPageContext pageContext, ISitemapManager sitemapManager)
+        {
+            // register demo events that the list control can emit
+            Stage.AddEvent(Event.MOVE_EVENT);
+
+            Stage.Description = @"A `RestList` control is a user interface component that retrieves data from a REST API and exposes CRUD-oriented interactions in a flat list representation. The control automatically fetches data from the API and renders the items as a list. Users can add, modify, delete, and reorder entries, with every action synchronized with the API. In addition, the control provides filtering and pagination for improved accessibility.";
+
+            Stage.Controls =
+            [
+                new ControlRestList("myList")
+                {
+                    RestUri = sitemapManager.GetUri<MonkeyIslandGames>(pageContext.ApplicationContext)
+                }
+                    .Add(new ControlRestFormGame("myListForm")
+                    {
+                        Uri = sitemapManager.GetUri<MonkeyIslandGames>(pageContext.ApplicationContext)
+                    })
+            ];
+
+            Stage.DarkControls =
+            [
+                new ControlText()
+                //new ControlRestList("myListDark")
+                //{
+                //    RestUri = sitemapManager.GetUri<MonkeyIslandCharacters>(pageContext.ApplicationContext)
+                //}
+                //    .Add(new ControlRestFormCharacter("myListDarkForm")
+                //    {
+                //        Uri = sitemapManager.GetUri<MonkeyIslandCharacters>(pageContext.ApplicationContext)
+                //    })
+            ];
+
+            Stage.Code = @"
+            new ControlRestList(""myList"")
+            {
+                RestUri = sitemapManager.GetUri<MonkeyIslandGames>(pageContext.ApplicationContext)
+            }
+                .Add(new ControlRestFormGame(""myListForm"")
+                {
+                    Uri = sitemapManager.GetUri<MonkeyIslandGames>(pageContext.ApplicationContext)
+                })";
+        }
+    }
+}