feature: organise on save

Author: jcdcdev

.github/README.md

@@ -11,6 +11,7 @@ Is your backoffice a bit untidy?
     - Media Types
     - Member Types
     - Data Types
+- Automatically sorts on save (configurable)
 
 ![A screenshot of the Back Office Organiser in action](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/main/docs/screenshots/backoffice.png)
 
@@ -27,13 +28,25 @@ Is your backoffice a bit untidy?
 Add the following to your `appsettings.json` file
 
 ```JSON
-	"BackOfficeOrganiser": {
-		"DataTypes": {
-			"InternalFolderName": "Internal",
-			"ThirdPartyFolderName": "Third Party",
-			"CustomFolderName": "Custom"
-		}
-	}
+{
+  "BackOfficeOrganiser": {
+    "DataTypes": {
+      "InternalFolderName": "Internal",
+      "ThirdPartyFolderName": "Third Party",
+      "CustomFolderName": "Custom",
+      "OrganiseOnSave": true
+    },
+    "ContentTypes": {
+      "OrganiseOnSave": true
+    },
+    "MediaTypes": {
+      "OrganiseOnSave": true
+    },
+    "MemberTypes": {
+      "OrganiseOnSave": true
+    }
+  }
+}
 ```
 
 ## Extending

src/TestSite.14/Program.cs

@@ -1,7 +1,3 @@
-using Microsoft.AspNetCore.Builder;
-using Umbraco.Cms.Core.DependencyInjection;
-using Umbraco.Extensions;
-
 var builder = WebApplication.CreateBuilder(args);
 
 builder.CreateUmbracoBuilder()
@@ -27,4 +23,4 @@
         u.UseWebsiteEndpoints();
     });
 
-await app.RunAsync();
+await app.RunAsync();

src/TestSite.14/Views/home.cshtml

@@ -1,5 +1,4 @@
-@using Umbraco.Cms.Web.Common.PublishedModels;
-@inherits Umbraco.Cms.Web.Common.Views.UmbracoViewPage
+@inherits UmbracoViewPage
 @{
 	Layout = null;
 }

src/Umbraco.Community.BackOfficeOrganiser/Composing/BackofficeOrganiserNotificationHandler.cs

@@ -0,0 +1,89 @@
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Events;
+using Umbraco.Cms.Core.Notifications;
+using Umbraco.Community.BackOfficeOrganiser.Models;
+using Umbraco.Community.BackOfficeOrganiser.Organisers.ContentTypes;
+using Umbraco.Community.BackOfficeOrganiser.Organisers.DataTypes;
+using Umbraco.Community.BackOfficeOrganiser.Organisers.MediaTypes;
+using Umbraco.Community.BackOfficeOrganiser.Organisers.MemberTypes;
+
+namespace Umbraco.Community.BackOfficeOrganiser.Composing;
+
+public class BackofficeOrganiserNotificationHandler :
+    INotificationAsyncHandler<DataTypeSavedNotification>,
+    INotificationAsyncHandler<ContentTypeSavedNotification>,
+    INotificationAsyncHandler<MemberTypeSavedNotification>,
+    INotificationAsyncHandler<MediaTypeSavedNotification>
+{
+    private readonly ContentTypeOrganiser _contentTypeOrganiser;
+    private readonly DataTypeOrganiser _dataTypeOrganiser;
+    private readonly MediaTypeOrganiser _mediaTypeOrganiser;
+    private readonly MemberTypeOrganiser _memberTypeOrganiser;
+    private readonly BackOfficeOrganiserOptions _options;
+
+    public BackofficeOrganiserNotificationHandler(
+        DataTypeOrganiser dataTypeOrganiser,
+        ContentTypeOrganiser contentTypeOrganiser,
+        MediaTypeOrganiser mediaTypeOrganiser,
+        MemberTypeOrganiser memberTypeOrganiser,
+        IOptions<BackOfficeOrganiserOptions> options)
+    {
+        _dataTypeOrganiser = dataTypeOrganiser;
+        _contentTypeOrganiser = contentTypeOrganiser;
+        _mediaTypeOrganiser = mediaTypeOrganiser;
+        _memberTypeOrganiser = memberTypeOrganiser;
+        _options = options.Value;
+    }
+
+    public async Task HandleAsync(ContentTypeSavedNotification notification, CancellationToken cancellationToken)
+    {
+        if (!_options.ContentTypes.OrganiseOnSave)
+        {
+            return;
+        }
+
+        foreach (var item in notification.SavedEntities)
+        {
+            await _contentTypeOrganiser.OrganiseTypeAsync(item);
+        }
+    }
+
+    public async Task HandleAsync(DataTypeSavedNotification notification, CancellationToken cancellationToken)
+    {
+        if (!_options.DataTypes.OrganiseOnSave)
+        {
+            return;
+        }
+
+        foreach (var dataType in notification.SavedEntities)
+        {
+            await _dataTypeOrganiser.OrganiseAsync(dataType);
+        }
+    }
+
+    public async Task HandleAsync(MediaTypeSavedNotification notification, CancellationToken cancellationToken)
+    {
+        if (!_options.MediaTypes.OrganiseOnSave)
+        {
+            return;
+        }
+
+        foreach (var item in notification.SavedEntities)
+        {
+            await _mediaTypeOrganiser.OrganiseTypeAsync(item);
+        }
+    }
+
+    public async Task HandleAsync(MemberTypeSavedNotification notification, CancellationToken cancellationToken)
+    {
+        if (!_options.MemberTypes.OrganiseOnSave)
+        {
+            return;
+        }
+
+        foreach (var item in notification.SavedEntities)
+        {
+            await _memberTypeOrganiser.OrganiseTypeAsync(item);
+        }
+    }
+}

src/Umbraco.Community.BackOfficeOrganiser/Composing/Composer.cs

@@ -1,6 +1,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Umbraco.Cms.Core.Composing;
 using Umbraco.Cms.Core.DependencyInjection;
+using Umbraco.Cms.Core.Notifications;
 using Umbraco.Community.BackOfficeOrganiser.Models;
 using Umbraco.Community.BackOfficeOrganiser.Organisers.ContentTypes;
 using Umbraco.Community.BackOfficeOrganiser.Organisers.DataTypes;
@@ -23,10 +24,15 @@ public void Compose(IUmbracoBuilder builder)
         builder.Services.AddSingleton<ContentTypeOrganiser>();
         builder.Services.AddSingleton<MemberTypeOrganiser>();
         builder.Services.AddSingleton<MediaTypeOrganiser>();
-        
+
         builder.DataTypeOrganiseActions().Append<DefaultDataTypeOrganiseAction>();
         builder.ContentTypeOrganiseActions().Append<DefaultContentTypeOrganiseAction>();
         builder.MediaTypeOrganiseActions().Append<DefaultMediaTypeOrganiseAction>();
         builder.MemberTypeOrganiseActions().Append<DefaultMemberTypeOrganiseAction>();
+
+        builder.AddNotificationAsyncHandler<DataTypeSavedNotification, BackofficeOrganiserNotificationHandler>();
+        builder.AddNotificationAsyncHandler<MediaTypeSavedNotification, BackofficeOrganiserNotificationHandler>();
+        builder.AddNotificationAsyncHandler<MemberTypeSavedNotification, BackofficeOrganiserNotificationHandler>();
+        builder.AddNotificationAsyncHandler<ContentTypeSavedNotification, BackofficeOrganiserNotificationHandler>();
     }
 }

src/Umbraco.Community.BackOfficeOrganiser/Controllers/BackOfficeOrganiserController.cs

@@ -39,7 +39,7 @@ public async Task<IActionResult> Organise([FromBody] OrganiseRequest model)
             return BadRequest(OrganiseResponse.Fail("Failed to organise"));
         }
 
-        return Ok(OrganiseResponse.Success($"Successfully organised 🚀"));
+        return Ok(OrganiseResponse.Success("Successfully organised \ud83d\ude80"));
     }
 
     private static OrganiseType DetermineOrganiseType(string input)

src/Umbraco.Community.BackOfficeOrganiser/Models/BackOfficeOrganiserOptions.cs

@@ -3,5 +3,8 @@ namespace Umbraco.Community.BackOfficeOrganiser.Models;
 public class BackOfficeOrganiserOptions
 {
     public DataTypeOptions DataTypes { get; set; } = new();
+    public ContentTypeOptions ContentTypes { get; set; } = new();
+    public MemberTypeOptions MemberTypes { get; set; } = new();
+    public MediaTypeOptions MediaTypes { get; set; } = new();
     public static string SectionName => "BackOfficeOrganiser";
 }

src/Umbraco.Community.BackOfficeOrganiser/Models/ContentTypeOptions.cs

@@ -0,0 +1,6 @@
+namespace Umbraco.Community.BackOfficeOrganiser.Models;
+
+public class ContentTypeOptions
+{
+    public bool OrganiseOnSave { get; set; } = true;
+}

src/Umbraco.Community.BackOfficeOrganiser/Models/DataTypeOptions.cs

@@ -5,4 +5,5 @@ public class DataTypeOptions
     public string InternalFolderName { get; set; } = "🔒 Internal";
     public string ThirdPartyFolderName { get; set; } = "🦄 Third Party";
     public string CustomFolderName { get; set; } = "🔧 Custom";
+    public bool OrganiseOnSave { get; set; } = true;
 }

src/Umbraco.Community.BackOfficeOrganiser/Models/MediaTypeOptions.cs

@@ -0,0 +1,6 @@
+namespace Umbraco.Community.BackOfficeOrganiser.Models;
+
+public class MediaTypeOptions
+{
+    public bool OrganiseOnSave { get; set; } = true;
+}