docs: add code examples for custom entity types and actions

Author: jcdcdev

src/Umbraco.Community.SimpleTrees.TestSite/Program.cs

@@ -1,6 +1,3 @@
-using Umbraco.Cms.Core.DependencyInjection;
-using Umbraco.Extensions;
-
 var builder = WebApplication.CreateBuilder(args);
 
 builder.CreateUmbracoBuilder()

src/Umbraco.Community.SimpleTrees.TestSite/Trees/ExampleTree.cs

@@ -1,9 +1,9 @@
 using Umbraco.Cms.Core.Models;
-using Umbraco.Community.SimpleTrees.Models;
+using Umbraco.Community.SimpleTrees.Core.Models;
 
 namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
 
-public class ExampleTree : SimpleTree
+public class ExampleTree(ISimpleTreeContext context) : SimpleTree(context)
 {
     public override Task<PagedModel<ISimpleTreeItem>> GetTreeRootAsync(int skip, int take, bool foldersOnly)
     {

src/Umbraco.Community.SimpleTrees.TestSite/Trees/MarketplaceRequest.cs

@@ -0,0 +1,8 @@
+using System.Text.Json.Serialization;
+
+namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
+
+public class MarketplaceRequest
+{
+    [JsonPropertyName("PackageId")] public required string PackageId { get; set; }
+}

src/Umbraco.Community.SimpleTrees.TestSite/Trees/MyMenu.cs

@@ -1,4 +1,4 @@
-using Umbraco.Community.SimpleTrees.Models;
+using Umbraco.Community.SimpleTrees.Core.Models;
 
 namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
 

src/Umbraco.Community.SimpleTrees.TestSite/Trees/MyTree.cs

@@ -1,9 +1,9 @@
 using Umbraco.Cms.Core.Models;
-using Umbraco.Community.SimpleTrees.Models;
+using Umbraco.Community.SimpleTrees.Core.Models;
 
 namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
 
-public class MyTree : SimpleTree
+public class MyTree(ISimpleTreeContext context) : SimpleTree(context)
 {
     public override Task<PagedModel<ISimpleTreeItem>> GetTreeRootAsync(int skip, int take, bool foldersOnly)
     {

src/Umbraco.Community.SimpleTrees.TestSite/Trees/NuGetMenu.cs

@@ -1,4 +1,4 @@
-using Umbraco.Community.SimpleTrees.Models;
+using Umbraco.Community.SimpleTrees.Core.Models;
 
 namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
 

src/Umbraco.Community.SimpleTrees.TestSite/Trees/NuGetPackageItemEntityExecuteAction.cs

@@ -0,0 +1,48 @@
+using System.Net.Http.Headers;
+using Umbraco.Community.SimpleTrees.Core.Models;
+using Umbraco.Community.SimpleTrees.Web.Models;
+
+namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
+
+public class NuGetPackageItemEntityExecuteAction : SimpleEntityExecuteAction
+{
+    private readonly HttpClient _client;
+
+    public NuGetPackageItemEntityExecuteAction(HttpClient client)
+    {
+        var url = "https://functions.marketplace.umbraco.com/api/";
+        client.BaseAddress = new Uri(url);
+        client.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue("Umbraco.Community.SimpleTrees.TestSite", "1.0"));
+        _client = client;
+    }
+
+    public override string Icon => "icon-refresh";
+    public override string Name => "Sync Package";
+    public override Type[] ForTreeItems => [typeof(NuGetPackageTree)];
+
+    public override async Task<SimpleEntityActionExecuteResponse> ExecuteAsync(string unique, string entityType)
+    {
+        try
+        {
+            var split = unique.Split('_');
+            var packageId = split[0];
+            var model = new MarketplaceRequest
+            {
+                PackageId = packageId,
+            };
+
+            var result = await _client.PostAsJsonAsync("InitiateSinglePackageSyncFunction", model);
+            if (!result.IsSuccessStatusCode)
+            {
+                return SimpleEntityActionExecuteResponse.Error("Failed to initiate package update", $"Status Code: {result.StatusCode}, Reason: {result.ReasonPhrase}");
+            }
+
+            var message = $"Package {packageId} update has been initiated. You can check the progress in the Umbraco Marketplace.";
+            return SimpleEntityActionExecuteResponse.Success("Package update initiated successfully", message);
+        }
+        catch (Exception ex)
+        {
+            return SimpleEntityActionExecuteResponse.Error("An error occurred while initiating the package update", ex.Message);
+        }
+    }
+}

src/Umbraco.Community.SimpleTrees.TestSite/Trees/NuGetPackageItemEntityUrlAction.cs

@@ -0,0 +1,27 @@
+using Umbraco.Community.SimpleTrees.Core.Models;
+
+namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
+
+public class NuGetPackageItemEntityUrlAction : SimpleEntityUrlAction
+{
+    public override string Icon => "icon-link";
+    public override string Name => "Go to Package";
+    public override Type[] ForTreeItems => [typeof(NuGetPackageTree)];
+    public override Type[] ForSimpleEntityTypes => [typeof(NuGetPackageVersionEntityType)];
+
+    public override Task<Uri> GetUrlAsync(string unique, string entityType)
+    {
+        var split = unique.Split('_');
+        var packageId = split[0];
+        var path = packageId;
+
+        if (split.Length > 1)
+        {
+            var version = split[1];
+            path += "/" + version + "#readme-body-tab";
+        }
+
+        var uri = new Uri("https://www.nuget.org/packages/" + path);
+        return Task.FromResult(uri);
+    }
+}

src/Umbraco.Community.SimpleTrees.TestSite/Trees/NuGetPackageTree.cs

@@ -1,11 +1,12 @@
 using Umbraco.Cms.Core.Models;
-using Umbraco.Community.SimpleTrees.Models;
+using Umbraco.Community.SimpleTrees.Core.Models;
 
 namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
 
-public class NuGetPackageTree : SimpleTree
+public class NuGetPackageTree(ISimpleTreeContext context) : SimpleTree(context)
 {
     private static readonly string[] Authors = ["jcdcdev", "umbraco"];
+    public override string Name => "NuGet Packages";
     public override string[] Menus => [nameof(NuGetMenu)];
 
     public override Task<PagedModel<ISimpleTreeItem>> GetTreeRootAsync(int skip, int take, bool foldersOnly)
@@ -24,8 +25,8 @@ public override async Task<PagedModel<ISimpleTreeItem>> GetTreeChildrenAsync(str
             var items = new List<ISimpleTreeItem>();
             foreach (var result in results)
             {
-                var item = CreateItem(result.Title, result.Identity.Id, parentUnique, "icon-document", hasChildren: true);
-                item.IsFolder = true;
+                var item = CreateItem(result.Title, result.Identity.Id, parentUnique, "icon-document", hasChildren: true, isFolder: true);
+                
                 items.Add(item);
             }
 
@@ -37,17 +38,13 @@ public override async Task<PagedModel<ISimpleTreeItem>> GetTreeChildrenAsync(str
         var versionItems = new List<ISimpleTreeItem>();
         foreach (var version in versions.Reverse())
         {
-            var item = CreateItem(
-                version.Identity.Version.ToString(),
-                $"{version.Identity.Id}_{version.Identity.Version}",
-                parentUnique,
-                "icon-box");
+            var name = version.Identity.Version.ToString();
+            var unique = $"{version.Identity.Id}_{version.Identity.Version}";
+            var item = CreateItem<NuGetPackageVersionEntityType>(name, unique, parentUnique);
 
             versionItems.Add(item);
         }
 
         return new PagedModel<ISimpleTreeItem>(versionItems.Count, versionItems);
     }
-
-    public override string Name => "NuGet Packages";
 }

src/Umbraco.Community.SimpleTrees.TestSite/Trees/NuGetPackageVersionEntityType.cs

@@ -0,0 +1,8 @@
+using Umbraco.Community.SimpleTrees.Core.Models;
+
+namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
+
+public class NuGetPackageVersionEntityType : SimpleEntityType
+{
+    public override string Icon => "icon-box";
+}