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

Author: ReneSchwarzer

src/WebUI/Model/Location.cs

@@ -0,0 +1,46 @@
+using System;
+using WebExpress.WebApp.WebRestApi;
+using WebExpress.WebCore.WebUri;
+
+namespace WebExpress.Tutorial.WebUI.Model
+{
+    /// <summary>
+    /// Represents a location entity for a selection control within "The Secret of Monkey Island".
+    /// </summary>
+    public class Location : IRestApiCrudSelectionItem
+    {
+        /// <summary>
+        /// Returns or sets the unique identifier of the location.
+        /// </summary>
+        public Guid Id { get; set; } = Guid.NewGuid();
+
+        /// <summary>
+        /// Returns or sets the display name of the location.
+        /// </summary>
+        public string Text { get; set; }
+
+        /// <summary>
+        /// Returns or sets a short description of the location.
+        /// </summary>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Returns or sets an optional deep link target to the location.
+        /// </summary>
+        public IUri Uri { get; set; }
+
+        /// <summary>
+        /// Returns or sets the island the location belongs to (e.g., "Melee Island", "Monkey Island").
+        /// </summary>
+        public string Island { get; set; }
+
+        /// <summary>
+        /// Returns a string representation including name, description, and island.
+        /// </summary>
+        /// <returns>A multi-line string describing the location.</returns>
+        public override string ToString()
+        {
+            return $"Text: {Text}\nDescription: {Description}\nIsland: {Island}";
+        }
+    }
+}

src/WebUI/Model/ViewModel.cs

@@ -17,6 +17,11 @@ public static class ViewModel
         /// </summary>
         public static List<Inventory> MonkeyIslanInventories { get; } = [.. GetMonkeyIslandInventories()];
 
+        /// <summary>
+        /// Returns the list of predefined locations in Monkey Island.
+        /// </summary>
+        public static List<Location> MonkeyIslanLocations { get; } = [.. GetMonkeyIslandLocations()];
+
         /// <summary>
         /// Retrieves a collection of characters from the Monkey Island universe.
         /// </summary>
@@ -540,5 +545,143 @@ public static IEnumerable<Inventory> GetMonkeyIslandInventories()
                 Description = "A handwritten note of dubious importance; pirates love leaving messages."
             };
         }
+
+        /// <summary>
+        /// Retrieves a collection of locations.
+        /// </summary>
+        /// <returns>An collection containing the locations.</returns>
+        public static IEnumerable<Location> GetMonkeyIslandLocations()
+        {
+            // locations from "The Secret of Monkey Island" (1990)
+            // melee island
+            yield return new Location
+            {
+                Text = "Lookout Point",
+                Description = "Clifftop vantage point where the Lookout keeps watch over Mêlée Island."
+            };
+            yield return new Location
+            {
+                Text = "Mêlée Island Village",
+                Description = "Central village street with shops and notable buildings."
+            };
+            yield return new Location
+            {
+                Text = "Scumm Bar",
+                Description = "Notorious pirate tavern by the docks."
+            };
+            yield return new Location
+            {
+                Text = "Docks",
+                Description = "Harbor area where ships moor and the Scumm Bar is located."
+            };
+            yield return new Location
+            {
+                Text = "Jail",
+                Description = "Small prison that houses characters like Otis."
+            };
+            yield return new Location
+            {
+                Text = "General Store",
+                Description = "Village shop run by the shopkeeper."
+            };
+            yield return new Location
+            {
+                Text = "Church",
+                Description = "Chapel used for certain story events."
+            };
+            yield return new Location
+            {
+                Text = "Alley",
+                Description = "Narrow back alley with hidden goings-on."
+            };
+            yield return new Location
+            {
+                Text = "Governor's Mansion",
+                Description = "Residence of Governor Elaine Marley, guarded by piranha poodles."
+            };
+            yield return new Location
+            {
+                Text = "Circus of the Fettuccini Brothers",
+                Description = "Traveling circus for daring stunts and a few bruises."
+            };
+            yield return new Location
+            {
+                Text = "Forest",
+                Description = "Maze-like woods that hide several paths and clearings."
+            };
+            yield return new Location
+            {
+                Text = "Fork in the Forest",
+                Description = "Signposted fork that helps (or hinders) orientation."
+            };
+            yield return new Location
+            {
+                Text = "Sword Master's House",
+                Description = "Secluded home of the Sword Master, reachable through the forest."
+            };
+            yield return new Location
+            {
+                Text = "Stan's Previously Owned Vessels",
+                Description = "Shipyard where Stan sells second-hand ships with flair."
+            };
+
+            // monkey island (key locations)
+            yield return new Location
+            {
+                Text = "Landing Beach",
+                Description = "Sandy shore where the Sea Monkey reaches Monkey Island."
+            };
+            yield return new Location
+            {
+                Text = "Jungle",
+                Description = "Dense jungle covering most of the island."
+            };
+            yield return new Location
+            {
+                Text = "Herman Toothrot's Camp",
+                Description = "Makeshift camp of castaway Herman Toothrot."
+            };
+            yield return new Location
+            {
+                Text = "Banana Grove",
+                Description = "Spot to acquire bananas for a helpful primate."
+            };
+            yield return new Location
+            {
+                Text = "Lagoon",
+                Description = "Quiet inland waterbody used in puzzle-solving."
+            };
+            yield return new Location
+            {
+                Text = "Cannibal Village",
+                Description = "Huts of the vegetarian cannibals with unique interior design."
+            };
+            yield return new Location
+            {
+                Text = "Giant Stone Monkey Head",
+                Description = "Ancient statue hiding an entrance to catacombs."
+            };
+            yield return new Location
+            {
+                Text = "Volcano Rim",
+                Description = "Fiery heart of the island visible near the catacombs."
+            };
+            yield return new Location
+            {
+                Text = "Sea Monkey Wreck",
+                Description = "The Sea Monkey in less-than-seaworthy condition on the shore."
+            };
+            yield return new Location
+            {
+                Text = "Catacombs",
+                Description = "Underground passages leading to LeChuck's ghost ship."
+            };
+            yield return new Location
+            {
+                Text = "LeChuck's Ghost Ship",
+                Description = "The dread pirate's vessel anchored in hidden waters."
+            };
+
+        }
     }
 }

…WebUI/WWW/Api/1/MonkeyIslandInventory.cs …bUI/WWW/Api/1/MonkeyIslandInventories.cssrc/WebUI/WWW/Api/1/MonkeyIslandInventory.cs renamed to src/WebUI/WWW/Api/1/MonkeyIslandInventories.cs src/WebUI/WWW/Api/1/MonkeyIslandInventory.cs renamed to src/WebUI/WWW/Api/1/MonkeyIslandInventories.cs

@@ -15,7 +15,7 @@ namespace WebExpress.Tutorial.WebUI.WWW.Api._1
     /// </summary>
     [Title("Monkey Island inventory")]
     [Method(CrudMethod.GET)]
-    public sealed class MonkeyIslandInventory : RestApiCrudDropdown<Inventory>
+    public sealed class MonkeyIslandInventories : RestApiCrudDropdown<Inventory>
     {
         /// <summary>
         /// Initializes a new instance of the class.
@@ -26,7 +26,7 @@ public sealed class MonkeyIslandInventory : RestApiCrudDropdown<Inventory>
         /// <param name="applicationContext">
         /// The application context containing the current state of the application.
         /// </param>
-        public MonkeyIslandInventory(ISitemapManager sitemapManager, IApplicationContext applicationContext)
+        public MonkeyIslandInventories(ISitemapManager sitemapManager, IApplicationContext applicationContext)
         {
             Data = ViewModel.MonkeyIslanInventories;
         }

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

@@ -0,0 +1,60 @@
+using System.Collections.Generic;
+using System.Linq;
+using WebExpress.Tutorial.WebUI.Model;
+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 selection for managing and retrieving data about Monkey Island locations.
+    /// </summary>
+    [Title("Monkey Island location")]
+    [Method(CrudMethod.GET)]
+    public sealed class MonkeyIslandLocations : RestApiCrudSelection<Location>
+    {
+        /// <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 MonkeyIslandLocations(ISitemapManager sitemapManager, IApplicationContext applicationContext)
+        {
+            Data = ViewModel.MonkeyIslanLocations;
+        }
+
+        /// <summary>
+        /// Retrieves a collection of objects based on the specified WQL statement and request.
+        /// </summary>
+        /// <param name="filter">
+        /// The filter used to query the data. This parameter defines the filtering and selection criteria.
+        /// </param>
+        /// <param name="request">
+        /// The request context containing additional information for the operation.
+        /// </param>
+        /// <returns>
+        /// An enumerable containing the objects that match the query criteria.
+        /// </returns>
+        public override IEnumerable<Location> GetData(string filter, Request request)
+        {
+            if (filter == null || filter == "null")
+            {
+                return Data;
+            }
+
+            return Data
+                .Where
+                (
+                    x => x.Text.Contains(filter, System.StringComparison.InvariantCultureIgnoreCase)
+                );
+        }
+    }
+}

src/WebUI/WWW/Controls/RestDropdown.cs

@@ -41,7 +41,7 @@ public RestDropDown(IPageContext pageContext, ISitemapManager sitemapManager)
                 new ControlRestDropdown("inventoryDropdown")
                 {
                     Text = "Inventory",
-                    RestUri = sitemapManager.GetUri<MonkeyIslandInventory>(pageContext.ApplicationContext)
+                    RestUri = sitemapManager.GetUri<MonkeyIslandInventories>(pageContext.ApplicationContext)
                 }
                     .Add(new ControlDropdownItemLink()
                     {
@@ -56,7 +56,7 @@ public RestDropDown(IPageContext pageContext, ISitemapManager sitemapManager)
                 new ControlRestDropdown("darkInventoryDropdown")
                 {
                     Text = "Inventory",
-                    RestUri = sitemapManager.GetUri<MonkeyIslandInventory>(pageContext.ApplicationContext)
+                    RestUri = sitemapManager.GetUri<MonkeyIslandInventories>(pageContext.ApplicationContext)
                 }
             ];
 
@@ -82,7 +82,7 @@ public RestDropDown(IPageContext pageContext, ISitemapManager sitemapManager)
                 new ControlRestDropdown("p_api")
                 {
                     Text = "Inventory",
-                    RestUri = sitemapManager.GetUri<MonkeyIslandInventory>(pageContext.ApplicationContext)
+                    RestUri = sitemapManager.GetUri<MonkeyIslandInventories>(pageContext.ApplicationContext)
                 }
             );
 
@@ -95,7 +95,7 @@ public RestDropDown(IPageContext pageContext, ISitemapManager sitemapManager)
                 new ControlRestDropdown("p_maxitems")
                 {
                     Text = "Inventory",
-                    RestUri = sitemapManager.GetUri<MonkeyIslandInventory>(pageContext.ApplicationContext),
+                    RestUri = sitemapManager.GetUri<MonkeyIslandInventories>(pageContext.ApplicationContext),
                     MaxItems = 10
                 }
             );
@@ -109,7 +109,7 @@ public RestDropDown(IPageContext pageContext, ISitemapManager sitemapManager)
                 new ControlRestDropdown("p_placeholder")
                 {
                     Text = "Inventory",
-                    RestUri = sitemapManager.GetUri<MonkeyIslandInventory>(pageContext.ApplicationContext),
+                    RestUri = sitemapManager.GetUri<MonkeyIslandInventories>(pageContext.ApplicationContext),
                     SearchPlaceholder = "Search entries..."
                 }
             );