Item manager asyncingess

uSync.BackOffice/Models/OrderedNodeInfo.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Text.Json.Serialization;
 using System.Xml.Linq;
 
 using Umbraco.Extensions;
@@ -27,6 +28,7 @@ public OrderedNodeInfo(string filename, XElement node)
     /// <summary>
     ///  set all the values of an ordered node. 
     /// </summary>
+    [JsonConstructor]
     public OrderedNodeInfo(string filename, XElement node, int level, string path, bool isRoot)
         : this(filename, node)
     {
@@ -48,7 +50,7 @@ public Guid Key
     /// <summary>
     ///  umbraco alias of the item
     /// </summary>
-    public string Alias { get; }
+    public string Alias { get;  }
 
     /// <summary>
     ///  relative path of the item (so same in all 'folders')

uSync.Backoffice.Management.Api/Configuration/ConfigSyncApiSwaggerGenOptions.cs

@@ -17,5 +17,6 @@ public void Configure(SwaggerGenOptions options)
               Version = "Latest",
               Description = "Api access uSync operations"
           });
+
     }
 }

uSync.Backoffice.Management.Client/uSync.Backoffice.Management.Client.csproj

@@ -8,4 +8,8 @@
 		<StaticWebAssetBasePath>/</StaticWebAssetBasePath>
 	</PropertyGroup>
 
+	<ItemGroup>
+	  <Folder Include="usync-assets\pack\" />
+	</ItemGroup>
+
 </Project>

uSync.Backoffice.Management.Client/usync-assets/package.json

@@ -2,7 +2,7 @@
 	"name": "@jumoo/usync-assets",
 	"license": "MPL-2.0",
 	"type": "module",
-	"version": "14.0.1-preview001",
+	"version": "14.1.0-build.20240819.1",
 	"main": "./dist/usync.js",
 	"types": "./dist/index.d.ts",
 	"module": "./dist/usync.js",

uSync.Backoffice.Management.Client/usync-assets/public/umbraco-package.json

@@ -2,7 +2,7 @@
   "$schema": "../umbraco-package-schema.json",
   "name": "uSync",
   "id": "uSync",
-  "version": "14.0.1-preview001",
+  "version": "14.1.0-build.20240819.1",
   "allowTelemetry": true,
   "extensions": [
     {

uSync.Core/Sync/ISyncItemManager.cs

@@ -13,7 +13,7 @@ public interface ISyncItemManager
     ///  Unless the item has some form of shared picker tree with the
     ///  core umbraco UI then answer is likely no (for now)
     /// </remarks>
-    SyncEntityInfo GetSyncInfo(string entityType);
+    SyncEntityInfo? GetSyncInfo(string entityType);
 
     /// <summary>
     ///   Which type of tree menu should be used. 
@@ -52,10 +52,18 @@ public interface ISyncItemManager
     ///  the process should as a bare minimum return the item it is passed, 
     ///  when the Include children flag is set - it should also return children. 
     /// </remarks>
-    IEnumerable<SyncItem> GetItems(SyncItem item);
+    Task<IEnumerable<SyncItem>> GetItemsAsync(SyncItem item);
 
     /// <summary>
     ///  Get the underling Local item for something that was picked from the tree.
     /// </summary>
-    SyncLocalItem GetEntity(SyncTreeItem treeItem);
+    Task<SyncLocalItem?> GetEntityAsync(SyncTreeItem treeItem);
+
+
+    /// <summary>
+    ///  for a given key find the sync entity. 
+    /// </summary>
+    /// <param name="key"></param>
+    /// <returns></returns>
+    Task<SyncEntity?> GetSyncEntityAsync(string key);
 }

uSync.Core/Sync/SyncItem.cs

@@ -5,20 +5,37 @@
 namespace uSync.Core.Sync;
 
 /// <summary>
-///  An item involved in a sync between servers. SyncItems are the start of any sync process
+///  the base for a syncing item. 
 /// </summary>
-public class SyncItem
+
+public class SyncEntity
 {
     /// <summary>
     ///  Name (to display) of the item
     /// </summary>
-    public string? Name { get; set; }
+    public required string Name { get; set; }
+
+    /// <summary>
+    ///  optional icon to display.
+    /// </summary>
+    public string? Icon { get; set; }
 
     /// <summary>
     ///  Umbraco UDI value to identify the item.
     /// </summary>
-    public Udi? Udi { get; set; }
+    public required Udi Udi { get; set; }
 
+    /// <summary>
+    ///  the entity type for the item.
+    /// </summary>
+    public string EntityType => Udi.EntityType;
+}
+
+/// <summary>
+///  An item involved in a sync between servers. SyncItems are the start of any sync process
+/// </summary>
+public class SyncItem : SyncEntity
+{
     /// <summary>
     ///  Flags controlling what is to be included when this item is exported
     /// </summary>

uSync.Core/Sync/SyncItemManagerBase.cs

@@ -54,26 +54,26 @@ protected string EntityType
     /// </summary>
     /// <param name="treeItem"></param>
     /// <returns></returns>
-    protected virtual SyncLocalItem GetRootItem(SyncTreeItem treeItem)
+    protected virtual SyncLocalItem? GetRootItem(SyncTreeItem treeItem)
         => new(Constants.System.RootString)
         {
             EntityType = EntityType,
             Name = EntityType,
             Udi = Udi.Create(EntityType)
         };
 
-    protected abstract IEnumerable<SyncItem> GetDescendants(SyncItem item, DependencyFlags flags);
+    protected abstract Task<IEnumerable<SyncItem>> GetDescendantsAsync(SyncItem item, DependencyFlags flags);
 
     /// <summary>
     ///  standard use case, if IncludeChildren flag is set, return this item and all its children.
     ///  if not just return this item. 
     /// </summary>
-    public virtual IEnumerable<SyncItem> GetItems(SyncItem item)
+    public virtual async Task<IEnumerable<SyncItem>> GetItemsAsync(SyncItem item)
     {
         if (item.Flags.HasFlag(DependencyFlags.IncludeChildren))
         {
             var items = new List<SyncItem> { item };
-            items.AddRange(GetDescendants(item, item.Flags & ~DependencyFlags.IncludeChildren));
+            items.AddRange(await GetDescendantsAsync(item, item.Flags & ~DependencyFlags.IncludeChildren));
             return items;
         }
         else
@@ -100,15 +100,16 @@ public virtual IEnumerable<SyncItem> GetItems(SyncItem item)
 /// </remarks>
 public abstract class SyncItemManagerIndexBase<TIndexType> : SyncItemManagerBase
 {
-    protected abstract SyncLocalItem GetLocalEntity(TIndexType id);
+    protected abstract Task<SyncLocalItem?> GetLocalEntityAsync(TIndexType id);
 
-    public virtual SyncLocalItem? GetEntity(SyncTreeItem treeItem)
+    /// <inheritdoc />
+    public virtual async Task<SyncLocalItem?> GetEntityAsync(SyncTreeItem treeItem)
     {
         if (treeItem.IsRoot()) return GetRootItem(treeItem);
 
         var attempt = treeItem.Id.TryConvertTo<TIndexType>();
         if (attempt.Success && attempt.Result is not null)
-            return GetLocalEntity(attempt.Result);
+            return await GetLocalEntityAsync(attempt.Result);
 
         return null;
     }