Merge branch 'develop' into stable

6 files changed, 70 insertions, 44 deletions

diff --git a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
index 2f58a3f1..4fc4ea54 100644
--- a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
+++ b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -1,3 +1,5 @@
+using System;
+
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 {
     /// <summary>Metadata about a mod.</summary>
@@ -7,15 +9,26 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         ** Accessors
         *********/
         /// <summary>The mod's unique ID (if known).</summary>
-        public string ID { get; set; }
+        public string ID { get; }
 
         /// <summary>The update version recommended by the web API based on its version update and mapping rules.</summary>
-        public ModEntryVersionModel SuggestedUpdate { get; set; }
+        public ModEntryVersionModel? SuggestedUpdate { get; set; }
 
         /// <summary>Optional extended data which isn't needed for update checks.</summary>
-        public ModExtendedMetadataModel Metadata { get; set; }
+        public ModExtendedMetadataModel? Metadata { get; set; }
 
         /// <summary>The errors that occurred while fetching update data.</summary>
-        public string[] Errors { get; set; } = new string[0];
+        public string[] Errors { get; set; } = Array.Empty<string>();
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="id">The mod's unique ID (if known).</param>
+        public ModEntryModel(string id)
+        {
+            this.ID = id;
+        }
     }
 }
diff --git a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs
index 188db31d..a1e78986 100644
--- a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs
+++ b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs
@@ -11,19 +11,16 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         *********/
         /// <summary>The version number.</summary>
         [JsonConverter(typeof(NonStandardSemanticVersionConverter))]
-        public ISemanticVersion Version { get; set; }
+        public ISemanticVersion Version { get; }
 
         /// <summary>The mod page URL.</summary>
-        public string Url { get; set; }
+        public string Url { get; }
 
 
         /*********
         ** Public methods
         *********/
         /// <summary>Construct an instance.</summary>
-        public ModEntryVersionModel() { }
-
-        /// <summary>Construct an instance.</summary>
         /// <param name="version">The version number.</param>
         /// <param name="url">The mod page URL.</param>
         public ModEntryVersionModel(ISemanticVersion version, string url)
diff --git a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
index 5c2ce366..272a2063 100644
--- a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
+++ b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using Newtonsoft.Json;
@@ -17,10 +18,10 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         ** Mod info
         ****/
         /// <summary>The mod's unique ID. A mod may have multiple current IDs in rare cases (e.g. due to parallel releases or unofficial updates).</summary>
-        public string[] ID { get; set; } = new string[0];
+        public string[] ID { get; set; } = Array.Empty<string>();
 
         /// <summary>The mod's display name.</summary>
-        public string Name { get; set; }
+        public string? Name { get; set; }
 
         /// <summary>The mod ID on Nexus.</summary>
         public int? NexusID { get; set; }
@@ -32,31 +33,31 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         public int? CurseForgeID { get; set; }
 
         /// <summary>The mod key in the CurseForge mod repo (used in mod page URLs).</summary>
-        public string CurseForgeKey { get; set; }
+        public string? CurseForgeKey { get; set; }
 
         /// <summary>The mod ID in the ModDrop mod repo.</summary>
         public int? ModDropID { get; set; }
 
         /// <summary>The GitHub repository in the form 'owner/repo'.</summary>
-        public string GitHubRepo { get; set; }
+        public string? GitHubRepo { get; set; }
 
         /// <summary>The URL to a non-GitHub source repo.</summary>
-        public string CustomSourceUrl { get; set; }
+        public string? CustomSourceUrl { get; set; }
 
         /// <summary>The custom mod page URL (if applicable).</summary>
-        public string CustomUrl { get; set; }
+        public string? CustomUrl { get; set; }
 
         /// <summary>The main version.</summary>
-        public ModEntryVersionModel Main { get; set; }
+        public ModEntryVersionModel? Main { get; set; }
 
         /// <summary>The latest optional version, if newer than <see cref="Main"/>.</summary>
-        public ModEntryVersionModel Optional { get; set; }
+        public ModEntryVersionModel? Optional { get; set; }
 
         /// <summary>The latest unofficial version, if newer than <see cref="Main"/> and <see cref="Optional"/>.</summary>
-        public ModEntryVersionModel Unofficial { get; set; }
+        public ModEntryVersionModel? Unofficial { get; set; }
 
         /// <summary>The latest unofficial version for the current Stardew Valley or SMAPI beta, if any.</summary>
-        public ModEntryVersionModel UnofficialForBeta { get; set; }
+        public ModEntryVersionModel? UnofficialForBeta { get; set; }
 
         /****
         ** Stable compatibility
@@ -66,10 +67,10 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         public WikiCompatibilityStatus? CompatibilityStatus { get; set; }
 
         /// <summary>The human-readable summary of the compatibility status or workaround, without HTML formatting.</summary>
-        public string CompatibilitySummary { get; set; }
+        public string? CompatibilitySummary { get; set; }
 
         /// <summary>The game or SMAPI version which broke this mod, if applicable.</summary>
-        public string BrokeIn { get; set; }
+        public string? BrokeIn { get; set; }
 
         /****
         ** Beta compatibility
@@ -79,22 +80,22 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         public WikiCompatibilityStatus? BetaCompatibilityStatus { get; set; }
 
         /// <summary>The human-readable summary of the compatibility status or workaround for the Stardew Valley beta (if any), without HTML formatting.</summary>
-        public string BetaCompatibilitySummary { get; set; }
+        public string? BetaCompatibilitySummary { get; set; }
 
         /// <summary>The beta game or SMAPI version which broke this mod, if applicable.</summary>
-        public string BetaBrokeIn { get; set; }
+        public string? BetaBrokeIn { get; set; }
 
         /****
         ** Version mappings
         ****/
         /// <summary>A serialized change descriptor to apply to the local version during update checks (see <see cref="ChangeDescriptor"/>).</summary>
-        public string ChangeLocalVersions { get; set; }
+        public string? ChangeLocalVersions { get; set; }
 
         /// <summary>A serialized change descriptor to apply to the remote version during update checks (see <see cref="ChangeDescriptor"/>).</summary>
-        public string ChangeRemoteVersions { get; set; }
+        public string? ChangeRemoteVersions { get; set; }
 
         /// <summary>A serialized change descriptor to apply to the update keys during update checks (see <see cref="ChangeDescriptor"/>).</summary>
-        public string ChangeUpdateKeys { get; set; }
+        public string? ChangeUpdateKeys { get; set; }
 
 
         /*********
@@ -110,7 +111,7 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <param name="optional">The latest optional version, if newer than <paramref name="main"/>.</param>
         /// <param name="unofficial">The latest unofficial version, if newer than <paramref name="main"/> and <paramref name="optional"/>.</param>
         /// <param name="unofficialForBeta">The latest unofficial version for the current Stardew Valley or SMAPI beta, if any.</param>
-        public ModExtendedMetadataModel(WikiModEntry wiki, ModDataRecord db, ModEntryVersionModel main, ModEntryVersionModel optional, ModEntryVersionModel unofficial, ModEntryVersionModel unofficialForBeta)
+        public ModExtendedMetadataModel(WikiModEntry? wiki, ModDataRecord? db, ModEntryVersionModel? main, ModEntryVersionModel? optional, ModEntryVersionModel? unofficial, ModEntryVersionModel? unofficialForBeta)
         {
             // versions
             this.Main = main;
diff --git a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs
index bf81e102..9c11e1db 100644
--- a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs
+++ b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs
@@ -1,3 +1,6 @@
+using System;
+using System.Linq;
+
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 {
     /// <summary>Specifies the identifiers for a mod to match.</summary>
@@ -7,37 +10,39 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         ** Accessors
         *********/
         /// <summary>The unique mod ID.</summary>
-        public string ID { get; set; }
+        public string ID { get; }
 
         /// <summary>The namespaced mod update keys (if available).</summary>
-        public string[] UpdateKeys { get; set; }
+        public string[] UpdateKeys { get; private set; }
 
         /// <summary>The mod version installed by the local player. This is used for version mapping in some cases.</summary>
-        public ISemanticVersion InstalledVersion { get; set; }
+        public ISemanticVersion? InstalledVersion { get; }
 
         /// <summary>Whether the installed version is broken or could not be loaded.</summary>
-        public bool IsBroken { get; set; }
+        public bool IsBroken { get; }
 
 
         /*********
         ** Public methods
         *********/
-        /// <summary>Construct an empty instance.</summary>
-        public ModSearchEntryModel()
-        {
-            // needed for JSON deserializing
-        }
-
         /// <summary>Construct an instance.</summary>
         /// <param name="id">The unique mod ID.</param>
         /// <param name="installedVersion">The version installed by the local player. This is used for version mapping in some cases.</param>
         /// <param name="updateKeys">The namespaced mod update keys (if available).</param>
         /// <param name="isBroken">Whether the installed version is broken or could not be loaded.</param>
-        public ModSearchEntryModel(string id, ISemanticVersion installedVersion, string[] updateKeys, bool isBroken = false)
+        public ModSearchEntryModel(string id, ISemanticVersion? installedVersion, string[]? updateKeys, bool isBroken = false)
         {
             this.ID = id;
             this.InstalledVersion = installedVersion;
-            this.UpdateKeys = updateKeys ?? new string[0];
+            this.UpdateKeys = updateKeys ?? Array.Empty<string>();
+            this.IsBroken = isBroken;
+        }
+
+        /// <summary>Add update keys for the mod.</summary>
+        /// <param name="updateKeys">The update keys to add.</param>
+        public void AddUpdateKeys(params string[] updateKeys)
+        {
+            this.UpdateKeys = this.UpdateKeys.Concat(updateKeys).ToArray();
         }
     }
 }
diff --git a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchModel.cs b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchModel.cs
index 73698173..3c74bab0 100644
--- a/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchModel.cs
+++ b/src/SMAPI.Toolkit/Framework/Clients/WebApi/ModSearchModel.cs
@@ -1,3 +1,5 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using StardewModdingAPI.Toolkit.Utilities;
 
@@ -22,16 +24,23 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         public ISemanticVersion GameVersion { get; set; }
 
         /// <summary>The OS on which the player plays.</summary>
-        public Platform? Platform { get; set; }
+        public Platform Platform { get; set; }
 
 
         /*********
         ** Public methods
         *********/
         /// <summary>Construct an empty instance.</summary>
+        [Obsolete("This constructor only exists to support ASP.NET model binding, and shouldn't be used directly.")]
+        [SuppressMessage("ReSharper", "UnusedMember.Global", Justification = "Used by ASP.NET model binding.")]
         public ModSearchModel()
         {
-            // needed for JSON deserializing
+            // ASP.NET Web API needs a public empty constructor for top-level request models, and
+            // it'll fail if the other constructor is marked with [JsonConstructor]. Apparently
+            // it's fine with non-empty constructors in nested models like ModSearchEntryModel.
+            this.Mods = Array.Empty<ModSearchEntryModel>();
+            this.ApiVersion = null!;
+            this.GameVersion = null!;
         }
 
         /// <summary>Construct an instance.</summary>
diff --git a/src/SMAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/SMAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
index c2d906a0..d4282617 100644
--- a/src/SMAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
+++ b/src/SMAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -62,15 +62,16 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         private TResult Post<TBody, TResult>(string url, TBody content)
         {
             // note: avoid HttpClient for macOS compatibility
-            using WebClient client = new WebClient();
+            using WebClient client = new();
 
-            Uri fullUrl = new Uri(this.BaseUrl, url);
+            Uri fullUrl = new(this.BaseUrl, url);
             string data = JsonConvert.SerializeObject(content);
 
             client.Headers["Content-Type"] = "application/json";
             client.Headers["User-Agent"] = $"SMAPI/{this.Version}";
             string response = client.UploadString(fullUrl, data);
-            return JsonConvert.DeserializeObject<TResult>(response, this.JsonSettings);
+            return JsonConvert.DeserializeObject<TResult>(response, this.JsonSettings)
+                ?? throw new InvalidOperationException($"Could not parse the response from POST {url}.");
         }
     }
 }