Merge remote-tracking branch 'origin/main' into develop/3.7.0

Author: sfmskywalker

.github/workflows/packages.yml

@@ -15,7 +15,7 @@ on:
   release:
     types: [ prereleased, published ]
 env:
-  base_version: '3.6.0'
+  base_version: '3.7.0'
   nuget_feed_feedzio: 'https://f.feedz.io/elsa-workflows/elsa-3/nuget/index.json'
   nuget_feed_nuget: 'https://api.nuget.org/v3/index.json'
   npm_feed_feedzio: 'https://f.feedz.io/elsa-workflows/elsa-3/npm/'

Directory.Packages.props

@@ -4,7 +4,7 @@
     <CentralPackageTransitivePinningEnabled>false</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
   <ItemGroup Label="Elsa">
-    <PackageVersion Include="Elsa.Api.Client" Version="3.6.0-preview.3976" />
+    <PackageVersion Include="Elsa.Api.Client" Version="3.7.0-preview.3141" />
   </ItemGroup>
   <ItemGroup>
     <PackageVersion Include="Blazored.FluentValidation" Version="2.2.0" />

Elsa.Studio.sln

@@ -86,6 +86,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Studio.Translations",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Studio.Host.HostedWasm", "src\hosts\Elsa.Studio.Host.HostedWasm\Elsa.Studio.Host.HostedWasm.csproj", "{25BA3052-4F17-4D24-9AE9-01FBD75E8804}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Studio.Labels", "src\modules\Elsa.Studio.Labels\Elsa.Studio.Labels.csproj", "{F6F4CD65-8E0C-5401-A668-108C6C0E8CD1}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -200,6 +202,10 @@ Global
 		{25BA3052-4F17-4D24-9AE9-01FBD75E8804}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{25BA3052-4F17-4D24-9AE9-01FBD75E8804}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{25BA3052-4F17-4D24-9AE9-01FBD75E8804}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F6F4CD65-8E0C-5401-A668-108C6C0E8CD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F6F4CD65-8E0C-5401-A668-108C6C0E8CD1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F6F4CD65-8E0C-5401-A668-108C6C0E8CD1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F6F4CD65-8E0C-5401-A668-108C6C0E8CD1}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -236,6 +242,7 @@ Global
 		{DE57FD2C-3874-486A-89B1-D982726A1189} = {D66B9A40-8608-46F3-9868-625C50EACE43}
 		{76C60D97-FA22-4023-BDB3-6BC47D097E40} = {C5288F1B-F4E5-423C-AEE8-049996613668}
 		{25BA3052-4F17-4D24-9AE9-01FBD75E8804} = {2AA1AEE9-017E-4F8B-B5FC-2BEA37E83514}
+		{F6F4CD65-8E0C-5401-A668-108C6C0E8CD1} = {D66B9A40-8608-46F3-9868-625C50EACE43}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {5B8719CC-CF87-45E1-BE1A-13842F951B28}

src/framework/Elsa.Studio.Core/Contracts/IActivityPickerComponentProvider.cs

@@ -0,0 +1,16 @@
+using Microsoft.AspNetCore.Components;
+
+namespace Elsa.Studio.Contracts;
+
+/// <summary>
+/// Defines a provider for an activity picker component,
+/// allowing for the retrieval of a RenderFragment to represent the component.
+/// </summary>
+public interface IActivityPickerComponentProvider
+{
+    /// <summary>
+    /// Retrieves a RenderFragment that represents the activity picker component.
+    /// </summary>
+    /// <returns>A RenderFragment instance containing the activity picker component.</returns>
+    RenderFragment GetActivityPickerComponent();
+}

src/framework/Elsa.Studio.Core/Contracts/IAppBarService.cs

@@ -1,25 +1,49 @@
+using Elsa.Studio.Models;
 using Microsoft.AspNetCore.Components;
 
 namespace Elsa.Studio.Contracts;
 
 /// <summary>
-/// Defines the contract for app bar service.
+/// Provides functionality for managing app bar items in the application.
 /// </summary>
 public interface IAppBarService
 {
     /// <summary>
     /// Invoked when the app bar items change.
     /// </summary>
     event Action AppBarItemsChanged;
+
+    /// <summary>
+    /// Gets the collection of elements displayed in the app bar.
+    /// </summary>
+    IEnumerable<AppBarElement> AppBarElements { get; }
 
     /// <summary>
     /// A collection of components to render in the app bar.
     /// </summary>
-    IEnumerable<RenderFragment> AppBarItems { get; }
+    IEnumerable<RenderFragment> AppBarComponents { get; }
 
     /// <summary>
     /// Adds a component to the app bar.
     /// </summary>
     /// <typeparam name="T">The type of the component.</typeparam>
+    [Obsolete("Use AddElement instead.")]
     void AddAppBarItem<T>() where T : IComponent;
+
+    /// <summary>
+    /// Adds a component of the specified type to the app bar.
+    /// </summary>
+    /// <typeparam name="T">The type of the component to add.</typeparam>
+    void AddComponent<T>(float? order = null) where T : IComponent;
+
+    /// <summary>
+    /// Adds an element of the specified type to the app bar.
+    /// </summary>
+    void AddElement<T>(float? order = null) where T : AppBarElement, new();
+
+    /// <summary>
+    /// Adds an element to the app bar.
+    /// </summary>
+    /// <param name="element">The app bar element to add.</param>
+    void AddElement(AppBarElement element);
 }

src/framework/Elsa.Studio.Core/ElsaStudioIcons.cs

@@ -70,6 +70,7 @@ public static class Tabler
         /// Provides the flask value.
         /// </summary>
         public const string Flask = """<svg width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">  <path stroke="none" d="M0 0h24v24H0z"/>  <line x1="9" y1="3" x2="15" y2="3" />  <line x1="10" y1="9" x2="14" y2="9" />  <path d="M10 3v6l-4 11a.7 .7 0 0 0 .5 1h11a.7 .7 0 0 0 .5 -1l-4 -11v-6" /></svg>""";
+        public const string MagicWand = """<svg width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">  <path stroke="none" d="M0 0h24v24H0z"/>  <polyline points="6 21 21 6 18 3 3 18 6 21" />  <line x1="15" y1="6" x2="18" y2="9" />  <path d="M9 3a2 2 0 0 0 2 2a2 2 0 0 0 -2 2a2 2 0 0 0 -2 -2a2 2 0 0 0 2 -2" />  <path d="M19 13a2 2 0 0 0 2 2a2 2 0 0 0 -2 2a2 2 0 0 0 -2 -2a2 2 0 0 0 2 -2" /></svg>""";
     }
 
     /// <summary>

src/framework/Elsa.Studio.Core/Extensions/RenderTreeBuilderExtensions.cs

@@ -25,4 +25,28 @@ public static void CreateComponent<T>(this RenderTreeBuilder builder, ref int se
         builder.OpenComponent<T>(sequence++);
         builder.CloseComponent();
     }
+
+    /// <summary>
+    /// Creates a component of the specified type at the specified sequence.
+    /// </summary>
+    /// <param name="builder">The <see cref="RenderTreeBuilder"/> to append the component to.</param>
+    /// <param name="sequence">The sequence number for the component.</param>
+    /// <param name="componentType">The type of the component to create.</param>
+    public static void CreateComponent(this RenderTreeBuilder builder, Type componentType)
+    {
+        var sequence = 0;
+        CreateComponent(builder, ref sequence, componentType);
+    }
+    
+    /// <summary>
+    /// Creates a component of the specified type at the specified sequence.
+    /// </summary>
+    /// <param name="builder">The <see cref="RenderTreeBuilder"/> to append the component to.</param>
+    /// <param name="sequence">The sequence number for the component.</param>
+    /// <param name="componentType">The type of the component to create.</param>
+    public static void CreateComponent(this RenderTreeBuilder builder, ref int sequence, Type componentType)
+    {
+        builder.OpenComponent(sequence++, componentType);
+        builder.CloseComponent();
+    }
 }

src/framework/Elsa.Studio.Core/MenuItemGroups.cs

@@ -3,16 +3,17 @@
 namespace Elsa.Studio;
 
 /// <summary>
-/// Represents the menu item groups.
+/// Provides predefined menu item groups for organizing application navigation.
 /// </summary>
 public static class MenuItemGroups
 {
     /// <summary>
-    /// Provides the general.
+    /// Gets the general menu item group for common application features.
     /// </summary>
     public static readonly MenuItemGroup General = new("general", "General", 0f);
+
     /// <summary>
-    /// Provides the settings.
+    /// Gets the settings menu item group for configuration and administrative features.
     /// </summary>
     public static readonly MenuItemGroup Settings = new("security", "Settings", 1000f);
 }

src/framework/Elsa.Studio.Core/Models/AppBarElement.cs

@@ -0,0 +1,48 @@
+using Elsa.Studio.Extensions;
+using Microsoft.AspNetCore.Components;
+
+namespace Elsa.Studio.Models;
+
+/// <summary>
+/// Represents an element in the application bar.
+/// Used to define components that can be rendered within the app bar with a specific order.
+/// </summary>
+/// <remarks>
+/// This class can be used to create custom app bar elements by specifying the order and the component to be rendered.
+/// The class can be instantiated directly or inherited to create specialized app bar elements.
+/// </remarks>
+public class AppBarElement
+{
+    /// <summary>
+    /// Gets or sets the order of the element within the application bar.
+    /// </summary>
+    /// <remarks>
+    /// Controls the placement of the element by specifying its position relative to others.
+    /// Lower values are placed earlier, and higher values are placed later in the sequence.
+    /// </remarks>
+    public virtual float Order { get; set; }
+
+    /// <summary>
+    /// Gets or sets the component to be rendered in the application bar.
+    /// </summary>
+    /// <remarks>
+    /// Represents the visual content of the app bar element. This content is defined as a render fragment,
+    /// allowing for dynamic and customizable rendering within the user interface.
+    /// </remarks>
+    public virtual RenderFragment Component { get; set; } = null!;
+}
+
+/// <summary>
+/// Represents an element in the application bar with a specific type constraint for its component.
+/// Used to define components of a specific type that can be rendered within the app bar.
+/// </summary>
+/// <typeparam name="T">The type of the component to be rendered, which must implement <see cref="IComponent"/>.</typeparam>
+/// <remarks>
+/// This generic specialization of the `AppBarElement` class enforces that only components of the specified type
+/// are allowed. The rendering logic uses the type parameter to instantiate the specified component.
+/// </remarks>
+public class AppBarElement<T> : AppBarElement where T : IComponent
+{
+    /// <inheritdoc />
+    public override RenderFragment Component { get; set; } = builder => builder.CreateComponent<T>();
+}

src/framework/Elsa.Studio.Core/Services/DefaultAppBarService.cs

@@ -1,33 +1,60 @@
 using Elsa.Studio.Contracts;
 using Elsa.Studio.Extensions;
+using Elsa.Studio.Models;
 using Microsoft.AspNetCore.Components;
 
 namespace Elsa.Studio.Services;
 
-/// <summary>
-/// Provides the default implementation of the app bar service.
-/// </summary>
+/// <inheritdoc />
 public class DefaultAppBarService : IAppBarService
 {
-    private readonly ICollection<RenderFragment> _appBarItems = new List<RenderFragment>();
-    private int _appBarSequence;
-    
-    /// <summary>
-    /// Occurs when the set of app bar items has changed.
-    /// </summary>
+    private readonly ICollection<AppBarElement> _elements = new List<AppBarElement>();
+
+    /// <inheritdoc />
     public event Action? AppBarItemsChanged;
-    /// <summary>
-    /// Gets the configured app bar items.
-    /// </summary>
-    public IEnumerable<RenderFragment> AppBarItems => _appBarItems.ToList();
-    
-    /// <summary>
-    /// Adds the specified component to the application bar.
-    /// </summary>
-    /// <typeparam name="T">The type of component to add.</typeparam>
+
+    /// <inheritdoc />
+    public IEnumerable<AppBarElement> AppBarElements => _elements.OrderBy(x => x.Order).ToList();
+
+    /// <inheritdoc />
+    public IEnumerable<RenderFragment> AppBarComponents => AppBarElements.Select(x => x.Component).ToList();
+
+    /// <inheritdoc />
     public void AddAppBarItem<T>() where T : IComponent
     {
-        _appBarItems.Add(builder => builder.CreateComponent<T>(ref _appBarSequence));
+        AddComponent<T>();
+    }
+
+    /// <inheritdoc />
+    public void AddComponent<T>(float? order = null) where T : IComponent
+    {
+        var element = new AppBarElement
+        {
+            Order = order ?? 0,
+            Component = builder => builder.CreateComponent<T>()
+        };
+
+        AddElement(element);
+    }
+
+    /// <inheritdoc />
+    public void AddElement<T>(float? order = null) where T : AppBarElement, new()
+    {
+        var element = new T();
+
+        if (order.HasValue)
+            element.Order = order.Value;
+
+        AddElement(element);
+    }
+
+    /// <inheritdoc />
+    public void AddElement(AppBarElement element)
+    {
+        if (_elements.Contains(element))
+            return;
+
+        _elements.Add(element);
         AppBarItemsChanged?.Invoke();
     }
 }