From f0bafee076892eb4e76ca9e16e47230acd8b37da Mon Sep 17 00:00:00 2001
From: Jedd Morgan <45512892+JR-Morgan@users.noreply.github.com>
Date: Wed, 12 Feb 2025 13:50:13 +0000
Subject: [PATCH] gql api changes (#226)

---
 src/Speckle.Sdk/Api/GraphQL/Models/Comment.cs | 33 ++++++++++++++++++-
 .../GraphQL/Models/SubscriptionMessages.cs    |  3 +-
 .../Api/GraphQL/Resources/CommentResource.cs  |  1 +
 3 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/src/Speckle.Sdk/Api/GraphQL/Models/Comment.cs b/src/Speckle.Sdk/Api/GraphQL/Models/Comment.cs
index 5637f57c..01da6610 100644
--- a/src/Speckle.Sdk/Api/GraphQL/Models/Comment.cs
+++ b/src/Speckle.Sdk/Api/GraphQL/Models/Comment.cs
@@ -1,4 +1,6 @@
-namespace Speckle.Sdk.Api.GraphQL.Models;
+using Speckle.Newtonsoft.Json;
+
+namespace Speckle.Sdk.Api.GraphQL.Models;
 
 public sealed class Comment
 {
@@ -17,4 +19,33 @@ public sealed class Comment
   public DateTime updatedAt { get; init; }
   public DateTime? viewedAt { get; init; }
   public List<ViewerResourceItem> viewerResources { get; init; }
+  public SerializedViewerState viewerState { get; init; }
+}
+
+/// <summary>
+/// See <c>SerializedViewerState</c> in <a href="https://github.com/specklesystems/speckle-server/blob/main/packages/shared/src/viewer/helpers/state.ts">/shared/src/viewer/helpers/state.ts</a>
+/// </summary>
+/// <remarks>
+/// Note, there are many FE/Viewer specific properties on this object that are not reflected here (hence the <see cref="MissingMemberHandling"/> override)
+/// We can add them as needed, keeping in mind flexiblity for breaking changes (these classes are intentionally not documented in our schema!)
+/// </remarks>
+[JsonObject(MissingMemberHandling = MissingMemberHandling.Ignore)]
+public sealed class SerializedViewerState
+{
+  public ViewerStateUI ui { get; init; }
+}
+
+[JsonObject(MissingMemberHandling = MissingMemberHandling.Ignore)]
+public sealed class ViewerStateUI
+{
+  public ViewerStateCamera camera { get; init; }
+}
+
+[JsonObject(MissingMemberHandling = MissingMemberHandling.Ignore)]
+public sealed class ViewerStateCamera
+{
+  public List<double> position { get; init; }
+  public List<double> target { get; init; }
+  public bool isOrthoProjection { get; init; }
+  public double zoom { get; init; }
 }
diff --git a/src/Speckle.Sdk/Api/GraphQL/Models/SubscriptionMessages.cs b/src/Speckle.Sdk/Api/GraphQL/Models/SubscriptionMessages.cs
index 9d4fe88a..327bac77 100644
--- a/src/Speckle.Sdk/Api/GraphQL/Models/SubscriptionMessages.cs
+++ b/src/Speckle.Sdk/Api/GraphQL/Models/SubscriptionMessages.cs
@@ -77,7 +77,8 @@ public sealed class ProjectVersionsUpdatedMessage : EventArgs
   [JsonRequired]
   public ProjectVersionsUpdatedMessageType type { get; init; }
 
-  public string? modelId { get; init; }
+  [JsonRequired]
+  public string modelId { get; init; }
 
   public Version? version { get; init; }
 }
diff --git a/src/Speckle.Sdk/Api/GraphQL/Resources/CommentResource.cs b/src/Speckle.Sdk/Api/GraphQL/Resources/CommentResource.cs
index 7f173ca9..30aed5e9 100644
--- a/src/Speckle.Sdk/Api/GraphQL/Resources/CommentResource.cs
+++ b/src/Speckle.Sdk/Api/GraphQL/Resources/CommentResource.cs
@@ -150,6 +150,7 @@ public sealed class CommentResource
                 objectId
                 versionId
               }
+              viewerState
             }
           }
         }