From d76964c5f381a5b8faba123646d851e7ae2c06f0 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sun, 29 Jan 2023 16:37:23 -0500
Subject: group response models

---
 .../ResponseModels/UpdateManifestModModel.cs       | 34 ++++++++++++++++++++++
 .../ResponseModels/UpdateManifestModel.cs          | 31 ++++++++++++++++++++
 .../ResponseModels/UpdateManifestVersionModel.cs   | 34 ++++++++++++++++++++++
 3 files changed, 99 insertions(+)
 create mode 100644 src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
 create mode 100644 src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
 create mode 100644 src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs

(limited to 'src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels')

diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
new file mode 100644
index 00000000..ee1fbeb6
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
@@ -0,0 +1,34 @@
+// Copyright 2022 Jamie Taylor
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
+{
+    /// <summary>The data model for a mod in an update manifest file.</summary>
+    internal class UpdateManifestModModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's name.</summary>
+        public string? Name { get; }
+
+        /// <summary>The mod page URL from which to download updates.</summary>
+        public string? Url { get; }
+
+        /// <summary>The available versions for this mod.</summary>
+        public UpdateManifestVersionModel[]? Versions { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="name">The mod's name.</param>
+        /// <param name="url">The mod page URL from which to download updates.</param>
+        /// <param name="versions">The available versions for this mod.</param>
+        public UpdateManifestModModel(string? name, string? url, UpdateManifestVersionModel[]? versions)
+        {
+            this.Name = name;
+            this.Url = url;
+            this.Versions = versions;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
new file mode 100644
index 00000000..e213fbab
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
@@ -0,0 +1,31 @@
+// Copyright 2022 Jamie Taylor
+using System.Collections.Generic;
+
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
+{
+    /// <summary>The data model for an update manifest file.</summary>
+    internal class UpdateManifestModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The manifest format version.</summary>
+        public string? ManifestVersion { get; }
+
+        /// <summary>The mod info in this update manifest.</summary>
+        public IDictionary<string, UpdateManifestModModel>? Mods { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="manifestVersion">The manifest format version.</param>
+        /// <param name="mods">The mod info in this update manifest.</param>
+        public UpdateManifestModel(string manifestVersion, IDictionary<string, UpdateManifestModModel> mods)
+        {
+            this.ManifestVersion = manifestVersion;
+            this.Mods = mods;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
new file mode 100644
index 00000000..1e84501f
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
@@ -0,0 +1,34 @@
+// Copyright 2022 Jamie Taylor
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
+{
+    /// <summary>Data model for a Version in an update manifest.</summary>
+    internal class UpdateManifestVersionModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's semantic version.</summary>
+        public string? Version { get; }
+
+        /// <summary>The URL for this version's download page (if any).</summary>
+        public string? DownloadPageUrl { get; }
+
+        /// <summary>The URL for this version's direct file download (if any).</summary>
+        public string? DownloadFileUrl { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="version">The mod's semantic version.</param>
+        /// <param name="downloadPageUrl">This version's download page URL, if any.</param>
+        /// <param name="downloadFileUrl">This version's direct file download URL, if any.</param>
+        public UpdateManifestVersionModel(string version, string? downloadPageUrl, string? downloadFileUrl)
+        {
+            this.Version = version;
+            this.DownloadPageUrl = downloadPageUrl;
+            this.DownloadFileUrl = downloadFileUrl;
+        }
+    }
+}
-- 
cgit 


From 610e2722c6687591faacb942d6f752c5f3c620d7 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sun, 29 Jan 2023 16:37:23 -0500
Subject: rename & validate format version

---
 .../UpdateManifest/ResponseModels/UpdateManifestModel.cs       | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels')

diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
index e213fbab..ff3dccbc 100644
--- a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
@@ -9,8 +9,8 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         /*********
         ** Accessors
         *********/
-        /// <summary>The manifest format version.</summary>
-        public string? ManifestVersion { get; }
+        /// <summary>The manifest format version. This is equivalent to the SMAPI version, and is used to parse older manifests correctly if later versions of SMAPI change the expected format.</summary>
+        public string Format { get; }
 
         /// <summary>The mod info in this update manifest.</summary>
         public IDictionary<string, UpdateManifestModModel>? Mods { get; }
@@ -20,11 +20,11 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         ** Public methods
         *********/
         /// <summary>Construct an instance.</summary>
-        /// <param name="manifestVersion">The manifest format version.</param>
+        /// <param name="format">The manifest format version.</param>
         /// <param name="mods">The mod info in this update manifest.</param>
-        public UpdateManifestModel(string manifestVersion, IDictionary<string, UpdateManifestModModel> mods)
+        public UpdateManifestModel(string format, IDictionary<string, UpdateManifestModModel> mods)
         {
-            this.ManifestVersion = manifestVersion;
+            this.Format = format;
             this.Mods = mods;
         }
     }
-- 
cgit 


From 3eb98b565f48c26384f0e83e4012fc9b40f1d819 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sun, 29 Jan 2023 16:37:23 -0500
Subject: simplify & validate manifest mod page URLs

This avoids an issue where users are told to download it from the JSON manifest URL.
---
 .../ResponseModels/UpdateManifestModModel.cs              | 14 ++++++++------
 .../UpdateManifest/ResponseModels/UpdateManifestModel.cs  |  6 +++---
 .../ResponseModels/UpdateManifestVersionModel.cs          | 15 +++++----------
 3 files changed, 16 insertions(+), 19 deletions(-)

(limited to 'src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels')

diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
index ee1fbeb6..418fb26b 100644
--- a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
@@ -1,4 +1,6 @@
 // Copyright 2022 Jamie Taylor
+using System;
+
 namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
 {
     /// <summary>The data model for a mod in an update manifest file.</summary>
@@ -11,10 +13,10 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         public string? Name { get; }
 
         /// <summary>The mod page URL from which to download updates.</summary>
-        public string? Url { get; }
+        public string? ModPageUrl { get; }
 
         /// <summary>The available versions for this mod.</summary>
-        public UpdateManifestVersionModel[]? Versions { get; }
+        public UpdateManifestVersionModel[] Versions { get; }
 
 
         /*********
@@ -22,13 +24,13 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         *********/
         /// <summary>Construct an instance.</summary>
         /// <param name="name">The mod's name.</param>
-        /// <param name="url">The mod page URL from which to download updates.</param>
+        /// <param name="modPageUrl">The mod page URL from which to download updates.</param>
         /// <param name="versions">The available versions for this mod.</param>
-        public UpdateManifestModModel(string? name, string? url, UpdateManifestVersionModel[]? versions)
+        public UpdateManifestModModel(string? name, string? modPageUrl, UpdateManifestVersionModel[]? versions)
         {
             this.Name = name;
-            this.Url = url;
-            this.Versions = versions;
+            this.ModPageUrl = modPageUrl;
+            this.Versions = versions ?? Array.Empty<UpdateManifestVersionModel>();
         }
     }
 }
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
index ff3dccbc..3b930ff3 100644
--- a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
@@ -13,7 +13,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         public string Format { get; }
 
         /// <summary>The mod info in this update manifest.</summary>
-        public IDictionary<string, UpdateManifestModModel>? Mods { get; }
+        public IDictionary<string, UpdateManifestModModel> Mods { get; }
 
 
         /*********
@@ -22,10 +22,10 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         /// <summary>Construct an instance.</summary>
         /// <param name="format">The manifest format version.</param>
         /// <param name="mods">The mod info in this update manifest.</param>
-        public UpdateManifestModel(string format, IDictionary<string, UpdateManifestModModel> mods)
+        public UpdateManifestModel(string format, IDictionary<string, UpdateManifestModModel>? mods)
         {
             this.Format = format;
-            this.Mods = mods;
+            this.Mods = mods ?? new Dictionary<string, UpdateManifestModModel>();
         }
     }
 }
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
index 1e84501f..7cfb0cfc 100644
--- a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
@@ -10,11 +10,8 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         /// <summary>The mod's semantic version.</summary>
         public string? Version { get; }
 
-        /// <summary>The URL for this version's download page (if any).</summary>
-        public string? DownloadPageUrl { get; }
-
-        /// <summary>The URL for this version's direct file download (if any).</summary>
-        public string? DownloadFileUrl { get; }
+        /// <summary>The mod page URL from which to download updates, if different from <see cref="UpdateManifestModModel.ModPageUrl"/>.</summary>
+        public string? ModPageUrl { get; }
 
 
         /*********
@@ -22,13 +19,11 @@ namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
         *********/
         /// <summary>Construct an instance.</summary>
         /// <param name="version">The mod's semantic version.</param>
-        /// <param name="downloadPageUrl">This version's download page URL, if any.</param>
-        /// <param name="downloadFileUrl">This version's direct file download URL, if any.</param>
-        public UpdateManifestVersionModel(string version, string? downloadPageUrl, string? downloadFileUrl)
+        /// <param name="modPageUrl">The mod page URL from which to download updates, if different from <see cref="UpdateManifestModModel.ModPageUrl"/>.</param>
+        public UpdateManifestVersionModel(string version, string? modPageUrl)
         {
             this.Version = version;
-            this.DownloadPageUrl = downloadPageUrl;
-            this.DownloadFileUrl = downloadFileUrl;
+            this.ModPageUrl = modPageUrl;
         }
     }
 }
-- 
cgit 


From b5f46000f4583dbb15a97981376a3695be2f74f3 Mon Sep 17 00:00:00 2001
From: Jamie Taylor <Jamie.Taylor@pobox.com>
Date: Sun, 29 Jan 2023 18:14:24 -0500
Subject: Remove copyright line from individual files

---
 .../Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs      | 1 -
 .../Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs         | 1 -
 .../Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs  | 1 -
 3 files changed, 3 deletions(-)

(limited to 'src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels')

diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
index 418fb26b..ead5c229 100644
--- a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
@@ -1,4 +1,3 @@
-// Copyright 2022 Jamie Taylor
 using System;
 
 namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
index 3b930ff3..5ccd31b0 100644
--- a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
@@ -1,4 +1,3 @@
-// Copyright 2022 Jamie Taylor
 using System.Collections.Generic;
 
 namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
index 7cfb0cfc..6678f5eb 100644
--- a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
@@ -1,4 +1,3 @@
-// Copyright 2022 Jamie Taylor
 namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
 {
     /// <summary>Data model for a Version in an update manifest.</summary>
-- 
cgit