Merge pull request #409 from specklesystems/bjorn/cnx-2722-grasshopper-root-collection-props

feat(grasshopper): add model-wide properties to send/receive

Author: bjoernsteinhagen

src/Speckle.Objects/Interfaces.cs

@@ -2,6 +2,7 @@
 using Speckle.Objects.Other;
 using Speckle.Objects.Primitive;
 using Speckle.Sdk.Models;
+using Speckle.Sdk.Models.Data;
 
 namespace Speckle.Objects;
 
@@ -110,15 +111,7 @@ public interface IDisplayValue<out T> : ISpeckleObject
 
 #region Data objects
 
-/// <summary>
-/// Specifies properties on objects to be used for data-based workflows
-/// </summary>
-public interface IProperties : ISpeckleObject
-{
-  Dictionary<string, object?> properties { get; }
-}
-
-public interface IDataObject : IProperties, IDisplayValue<IReadOnlyList<Base>>
+public interface IDataObject : IProperties, IDisplayValue<IReadOnlyList<Base>>, ISpeckleObject
 {
   /// <summary>
   /// The name of the object, primarily used to decorate the object for consumption in frontend and other apps

src/Speckle.Sdk/Models/Collections/RootCollection.cs

@@ -0,0 +1,21 @@
+using Speckle.Sdk.Models.Data;
+
+namespace Speckle.Sdk.Models.Collections;
+
+/// <summary>
+/// Root collection that represents the top-level commit object.
+/// Extends Collection to include model-wide properties that apply to the entire model.
+/// </summary>
+[SpeckleType("Speckle.Core.Models.Collections.RootCollection")]
+public class RootCollection : Collection, IProperties
+{
+  public RootCollection() { }
+
+  public RootCollection(string name)
+    : base(name) { }
+
+  /// <summary>
+  /// Model-wide properties that apply to the entire model.
+  /// </summary>
+  public Dictionary<string, object?> properties { get; set; } = new();
+}

src/Speckle.Sdk/Models/Data/IProperties.cs

@@ -0,0 +1,10 @@
+namespace Speckle.Sdk.Models.Data;
+
+/// <summary>
+/// Specifies properties on objects to be used for data-based workflows.
+/// Can be applied to both objects and collections.
+/// </summary>
+public interface IProperties
+{
+  Dictionary<string, object?> properties { get; }
+}