From 03860cca868aceb6af67d9a6ad171c8ceb9be7eb Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 25 May 2018 19:26:09 -0400
Subject: add wiki compatibility list parsing to toolkit (#532)

---
 .../Clients/Wiki/WikiCompatibilityClient.cs        | 142 +++++++++++++++++++++
 .../Clients/Wiki/WikiCompatibilityEntry.cs         |  24 ++++
 .../Clients/Wiki/WikiCompatibilityStatus.cs        |  24 ++++
 3 files changed, 190 insertions(+)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
new file mode 100644
index 00000000..be03a120
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
@@ -0,0 +1,142 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+using System.Threading.Tasks;
+using HtmlAgilityPack;
+using Pathoschild.Http.Client;
+
+namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
+{
+    /// <summary>An HTTP client for fetching mod metadata from the wiki compatibility list.</summary>
+    public class WikiCompatibilityClient : IDisposable
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The underlying HTTP client.</summary>
+        private readonly IClient Client;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="userAgent">The user agent for the wiki API.</param>
+        /// <param name="baseUrl">The base URL for the wiki API.</param>
+        public WikiCompatibilityClient(string userAgent, string baseUrl = "https://stardewvalleywiki.com/mediawiki/api.php")
+        {
+            this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent);
+        }
+
+        /// <summary>Fetch mod compatibility entries.</summary>
+        public async Task<WikiCompatibilityEntry[]> FetchAsync()
+        {
+            // fetch HTML
+            ResponseModel response = await this.Client
+                .GetAsync("")
+                .WithArguments(new
+                {
+                    action = "parse",
+                    page = "Modding:SMAPI_compatibility",
+                    format = "json"
+                })
+                .As<ResponseModel>();
+            string html = response.Parse.Text["*"];
+
+            // parse HTML
+            var doc = new HtmlDocument();
+            doc.LoadHtml(html);
+
+            // find mod entries
+            HtmlNodeCollection modNodes = doc.DocumentNode.SelectNodes("table[@id='mod-list']//tr[@class='mod']");
+            if (modNodes == null)
+                throw new InvalidOperationException("Can't parse wiki compatibility list, no mods found.");
+
+            // parse
+            return this.ParseEntries(modNodes).ToArray();
+        }
+
+        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
+        public void Dispose()
+        {
+            this.Client?.Dispose();
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Parse valid mod compatibility entries.</summary>
+        /// <param name="nodes">The HTML compatibility entries.</param>
+        private IEnumerable<WikiCompatibilityEntry> ParseEntries(IEnumerable<HtmlNode> nodes)
+        {
+            foreach (HtmlNode node in nodes)
+            {
+                // parse status
+                WikiCompatibilityStatus status;
+                {
+                    string rawStatus = node.GetAttributeValue("data-status", null);
+                    if (rawStatus == null)
+                        continue; // not a mod node?
+                    if (!Enum.TryParse(rawStatus, true, out status))
+                        throw new InvalidOperationException($"Unknown status '{rawStatus}' when parsing compatibility list.");
+                }
+
+                // parse unofficial version
+                ISemanticVersion unofficialVersion = null;
+                {
+                    string rawUnofficialVersion = node.GetAttributeValue("data-unofficial-version", null);
+                    SemanticVersion.TryParse(rawUnofficialVersion, out unofficialVersion);
+                }
+
+                // parse other fields
+                int? nexusID = this.GetNullableIntAttribute(node, "data-nexus-id");
+                int? chucklefishID = this.GetNullableIntAttribute(node, "data-chucklefish-id");
+                string githubRepo = node.GetAttributeValue("data-github", null);
+                string customSourceUrl = node.GetAttributeValue("data-custom-source", null);
+
+                // yield model
+                yield return new WikiCompatibilityEntry
+                {
+                    Status = status,
+                    NexusID = nexusID,
+                    ChucklefishID = chucklefishID,
+                    GitHubRepo = githubRepo,
+                    CustomSourceUrl = customSourceUrl,
+                    UnofficialVersion = unofficialVersion
+                };
+            }
+        }
+
+        /// <summary>Get a nullable integer attribute value.</summary>
+        /// <param name="node">The HTML node.</param>
+        /// <param name="attributeName">The attribute name.</param>
+        private int? GetNullableIntAttribute(HtmlNode node, string attributeName)
+        {
+            string raw = node.GetAttributeValue(attributeName, null);
+            if (raw != null && int.TryParse(raw, out int value))
+                return value;
+            return null;
+        }
+
+        /// <summary>The response model for the MediaWiki parse API.</summary>
+        [SuppressMessage("ReSharper", "ClassNeverInstantiated.Local")]
+        [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Local")]
+        private class ResponseModel
+        {
+            /// <summary>The parse API results.</summary>
+            public ResponseParseModel Parse { get; set; }
+        }
+
+        /// <summary>The inner response model for the MediaWiki parse API.</summary>
+        [SuppressMessage("ReSharper", "ClassNeverInstantiated.Local")]
+        [SuppressMessage("ReSharper", "CollectionNeverUpdated.Local")]
+        [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Local")]
+        private class ResponseParseModel
+        {
+            /// <summary>The parsed text.</summary>
+            public IDictionary<string, string> Text { get; set; }
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
new file mode 100644
index 00000000..ceeb2de5
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
@@ -0,0 +1,24 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
+{
+    /// <summary>An entry in the mod compatibility list.</summary>
+    public class WikiCompatibilityEntry
+    {
+        /// <summary>The mod ID on Nexus.</summary>
+        public int? NexusID { get; set; }
+
+        /// <summary>The mod ID in the Chucklefish mod repo.</summary>
+        public int? ChucklefishID { get; set; }
+
+        /// <summary>The GitHub repository in the form 'owner/repo'.</summary>
+        public string GitHubRepo { get; set; }
+
+        /// <summary>The URL to a non-GitHub source repo.</summary>
+        public string CustomSourceUrl { get; set; }
+
+        /// <summary>The version of the latest unofficial update, if applicable.</summary>
+        public ISemanticVersion UnofficialVersion { get; set; }
+
+        /// <summary>The compatibility status.</summary>
+        public WikiCompatibilityStatus Status { get; set; }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs
new file mode 100644
index 00000000..06252b2f
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs
@@ -0,0 +1,24 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
+{
+    /// <summary>The compatibility status for a mod.</summary>
+    public enum WikiCompatibilityStatus
+    {
+        /// <summary>The mod is compatible.</summary>
+        Ok = 0,
+
+        /// <summary>The mod is compatible if you use an optional official download.</summary>
+        Optional = 1,
+
+        /// <summary>The mod isn't compatible, but the player can fix it or there's a good alternative.</summary>
+        Workaround = 2,
+
+        /// <summary>The mod isn't compatible.</summary>
+        Broken = 3,
+
+        /// <summary>The mod is no longer maintained by the author, and an unofficial update or continuation is unlikely.</summary>
+        Abandoned = 4,
+
+        /// <summary>The mod is no longer needed and should be removed.</summary>
+        Obsolete = 5
+    }
+}
-- 
cgit 


From 738c0ce386590f55c185297065aeda62b1f5d06f Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 26 May 2018 15:21:07 -0400
Subject: improve wiki parsing (#532)

---
 .../Clients/Wiki/WikiCompatibilityClient.cs        | 23 +++++++++++++++++++---
 .../Clients/Wiki/WikiCompatibilityEntry.cs         |  9 +++++++++
 2 files changed, 29 insertions(+), 3 deletions(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
index be03a120..a68a0b4e 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
@@ -91,19 +91,25 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
                 }
 
                 // parse other fields
+                string name = node.Descendants("td").FirstOrDefault()?.InnerText?.Trim();
+                string[] ids = this.GetAttribute(node, "data-id")?.Split(new [] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(p => p.Trim()).ToArray() ?? new string[0];
                 int? nexusID = this.GetNullableIntAttribute(node, "data-nexus-id");
                 int? chucklefishID = this.GetNullableIntAttribute(node, "data-chucklefish-id");
-                string githubRepo = node.GetAttributeValue("data-github", null);
-                string customSourceUrl = node.GetAttributeValue("data-custom-source", null);
+                string githubRepo = this.GetAttribute(node, "data-github");
+                string customSourceUrl = this.GetAttribute(node, "data-custom-source");
+                string customUrl = this.GetAttribute(node, "data-custom-url");
 
                 // yield model
                 yield return new WikiCompatibilityEntry
                 {
+                    ID = ids,
+                    Name = name,
                     Status = status,
                     NexusID = nexusID,
                     ChucklefishID = chucklefishID,
                     GitHubRepo = githubRepo,
                     CustomSourceUrl = customSourceUrl,
+                    CustomUrl = customUrl,
                     UnofficialVersion = unofficialVersion
                 };
             }
@@ -114,12 +120,23 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
         /// <param name="attributeName">The attribute name.</param>
         private int? GetNullableIntAttribute(HtmlNode node, string attributeName)
         {
-            string raw = node.GetAttributeValue(attributeName, null);
+            string raw = this.GetAttribute(node, attributeName);
             if (raw != null && int.TryParse(raw, out int value))
                 return value;
             return null;
         }
 
+        /// <summary>Get a strings attribute value.</summary>
+        /// <param name="node">The HTML node.</param>
+        /// <param name="attributeName">The attribute name.</param>
+        private string GetAttribute(HtmlNode node, string attributeName)
+        {
+            string raw = node.GetAttributeValue(attributeName, null);
+            if (raw != null)
+                raw = HtmlEntity.DeEntitize(raw);
+            return raw;
+        }
+
         /// <summary>The response model for the MediaWiki parse API.</summary>
         [SuppressMessage("ReSharper", "ClassNeverInstantiated.Local")]
         [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Local")]
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
index ceeb2de5..9aabdcba 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
@@ -3,6 +3,12 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
     /// <summary>An entry in the mod compatibility list.</summary>
     public class WikiCompatibilityEntry
     {
+        /// <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; }
+
+        /// <summary>The mod's display name.</summary>
+        public string Name { get; set; }
+
         /// <summary>The mod ID on Nexus.</summary>
         public int? NexusID { get; set; }
 
@@ -15,6 +21,9 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
         /// <summary>The URL to a non-GitHub source repo.</summary>
         public string CustomSourceUrl { get; set; }
 
+        /// <summary>The custom mod page URL (if applicable).</summary>
+        public string CustomUrl { get; set; }
+
         /// <summary>The version of the latest unofficial update, if applicable.</summary>
         public ISemanticVersion UnofficialVersion { get; set; }
 
-- 
cgit 


From 9945408aa4ea2f6e07c2820f6aa1c160c68423d5 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Wed, 30 May 2018 21:21:33 -0400
Subject: add summary and 'unofficial' status to wiki client (#532)

---
 .../Framework/Clients/Wiki/WikiCompatibilityClient.cs         |  6 ++++--
 .../Framework/Clients/Wiki/WikiCompatibilityEntry.cs          |  3 +++
 .../Framework/Clients/Wiki/WikiCompatibilityStatus.cs         | 11 +++++++----
 3 files changed, 14 insertions(+), 6 deletions(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
index a68a0b4e..d0da42df 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityClient.cs
@@ -92,7 +92,8 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
 
                 // parse other fields
                 string name = node.Descendants("td").FirstOrDefault()?.InnerText?.Trim();
-                string[] ids = this.GetAttribute(node, "data-id")?.Split(new [] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(p => p.Trim()).ToArray() ?? new string[0];
+                string summary = node.Descendants("td").FirstOrDefault(p => p.GetAttributeValue("class", null) == "summary")?.InnerText.Trim();
+                string[] ids = this.GetAttribute(node, "data-id")?.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(p => p.Trim()).ToArray() ?? new string[0];
                 int? nexusID = this.GetNullableIntAttribute(node, "data-nexus-id");
                 int? chucklefishID = this.GetNullableIntAttribute(node, "data-chucklefish-id");
                 string githubRepo = this.GetAttribute(node, "data-github");
@@ -110,7 +111,8 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
                     GitHubRepo = githubRepo,
                     CustomSourceUrl = customSourceUrl,
                     CustomUrl = customUrl,
-                    UnofficialVersion = unofficialVersion
+                    UnofficialVersion = unofficialVersion,
+                    Summary = summary
                 };
             }
         }
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
index 9aabdcba..8bc66e20 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityEntry.cs
@@ -29,5 +29,8 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
 
         /// <summary>The compatibility status.</summary>
         public WikiCompatibilityStatus Status { get; set; }
+
+        /// <summary>The human-readable summary of the compatibility status or workaround, without HTML formatitng.</summary>
+        public string Summary { get; set; }
     }
 }
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs
index 06252b2f..a1d2dfae 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/Wiki/WikiCompatibilityStatus.cs
@@ -9,16 +9,19 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.Wiki
         /// <summary>The mod is compatible if you use an optional official download.</summary>
         Optional = 1,
 
+        /// <summary>The mod is compatible if you use an unofficial update.</summary>
+        Unofficial = 2,
+
         /// <summary>The mod isn't compatible, but the player can fix it or there's a good alternative.</summary>
-        Workaround = 2,
+        Workaround = 3,
 
         /// <summary>The mod isn't compatible.</summary>
-        Broken = 3,
+        Broken = 4,
 
         /// <summary>The mod is no longer maintained by the author, and an unofficial update or continuation is unlikely.</summary>
-        Abandoned = 4,
+        Abandoned = 5,
 
         /// <summary>The mod is no longer needed and should be removed.</summary>
-        Obsolete = 5
+        Obsolete = 6
     }
 }
-- 
cgit 


From de74b038e4c15d393de8828c89814ef7eaefe507 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 2 Jun 2018 18:22:04 -0400
Subject: move web API client into toolkit (#532)

---
 .../Framework/Clients/WebApi/ModInfoModel.cs       | 56 +++++++++++++++++
 .../Framework/Clients/WebApi/ModSeachModel.cs      | 37 ++++++++++++
 .../Framework/Clients/WebApi/WebApiClient.cs       | 70 ++++++++++++++++++++++
 3 files changed, 163 insertions(+)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
new file mode 100644
index 00000000..e1a204c6
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
@@ -0,0 +1,56 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Generic metadata about a mod.</summary>
+    public class ModInfoModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The semantic version for the mod's latest release.</summary>
+        public string Version { get; set; }
+
+        /// <summary>The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</summary>
+        public string PreviewVersion { get; set; }
+
+        /// <summary>The mod's web URL.</summary>
+        public string Url { get; set; }
+
+        /// <summary>The error message indicating why the mod is invalid (if applicable).</summary>
+        public string Error { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an empty instance.</summary>
+        public ModInfoModel()
+        {
+            // needed for JSON deserialising
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="name">The mod name.</param>
+        /// <param name="version">The semantic version for the mod's latest release.</param>
+        /// <param name="previewVersion">The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</param>
+        /// <param name="url">The mod's web URL.</param>
+        /// <param name="error">The error message indicating why the mod is invalid (if applicable).</param>
+        public ModInfoModel(string name, string version, string url, string previewVersion = null, string error = null)
+        {
+            this.Name = name;
+            this.Version = version;
+            this.PreviewVersion = previewVersion;
+            this.Url = url;
+            this.Error = error; // mainly initialised here for the JSON deserialiser
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="error">The error message indicating why the mod is invalid.</param>
+        public ModInfoModel(string error)
+        {
+            this.Error = error;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
new file mode 100644
index 00000000..c0ee34ea
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
@@ -0,0 +1,37 @@
+using System.Collections.Generic;
+using System.Linq;
+
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Specifies mods whose update-check info to fetch.</summary>
+    public class ModSearchModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The namespaced mod keys to search.</summary>
+        public string[] ModKeys { get; set; }
+
+        /// <summary>Whether to allow non-semantic versions, instead of returning an error for those.</summary>
+        public bool AllowInvalidVersions { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an empty instance.</summary>
+        public ModSearchModel()
+        {
+            // needed for JSON deserialising
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="modKeys">The namespaced mod keys to search.</param>
+        /// <param name="allowInvalidVersions">Whether to allow non-semantic versions, instead of returning an error for those.</param>
+        public ModSearchModel(IEnumerable<string> modKeys, bool allowInvalidVersions)
+        {
+            this.ModKeys = modKeys.ToArray();
+            this.AllowInvalidVersions = allowInvalidVersions;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
new file mode 100644
index 00000000..277fbeeb
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -0,0 +1,70 @@
+using System;
+using System.Collections.Generic;
+using System.Net;
+using Newtonsoft.Json;
+
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Provides methods for interacting with the SMAPI web API.</summary>
+    internal class WebApiClient
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The base URL for the web API.</summary>
+        private readonly Uri BaseUrl;
+
+        /// <summary>The API version number.</summary>
+        private readonly ISemanticVersion Version;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="baseUrl">The base URL for the web API.</param>
+        /// <param name="version">The web API version.</param>
+        public WebApiClient(string baseUrl, ISemanticVersion version)
+        {
+#if !SMAPI_FOR_WINDOWS
+            baseUrl = baseUrl.Replace("https://", "http://"); // workaround for OpenSSL issues with the game's bundled Mono on Linux/Mac
+#endif
+            this.BaseUrl = new Uri(baseUrl);
+            this.Version = version;
+        }
+
+        /// <summary>Get the latest SMAPI version.</summary>
+        /// <param name="modKeys">The mod keys for which to fetch the latest version.</param>
+        public IDictionary<string, ModInfoModel> GetModInfo(params string[] modKeys)
+        {
+            return this.Post<ModSearchModel, Dictionary<string, ModInfoModel>>(
+                $"v{this.Version}/mods",
+                new ModSearchModel(modKeys, allowInvalidVersions: true)
+            );
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Fetch the response from the backend API.</summary>
+        /// <typeparam name="TBody">The body content type.</typeparam>
+        /// <typeparam name="TResult">The expected response type.</typeparam>
+        /// <param name="url">The request URL, optionally excluding the base URL.</param>
+        /// <param name="content">The body content to post.</param>
+        private TResult Post<TBody, TResult>(string url, TBody content)
+        {
+            // note: avoid HttpClient for Mac compatibility
+            using (WebClient client = new WebClient())
+            {
+                Uri fullUrl = new Uri(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);
+            }
+        }
+    }
+}
-- 
cgit 


From 570b19ca7a16dc6af901a8869f178a8196147fb0 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Tue, 5 Jun 2018 21:38:24 -0400
Subject: tweak client for reuse in toolkit (#532)

---
 .../Framework/Clients/WebApi/WebApiClient.cs       | 34 +++++++++++++++++++---
 1 file changed, 30 insertions(+), 4 deletions(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
index 277fbeeb..d94b0259 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -1,12 +1,13 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net;
 using Newtonsoft.Json;
 
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 {
     /// <summary>Provides methods for interacting with the SMAPI web API.</summary>
-    internal class WebApiClient
+    public class WebApiClient
     {
         /*********
         ** Properties
@@ -26,9 +27,6 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <param name="version">The web API version.</param>
         public WebApiClient(string baseUrl, ISemanticVersion version)
         {
-#if !SMAPI_FOR_WINDOWS
-            baseUrl = baseUrl.Replace("https://", "http://"); // workaround for OpenSSL issues with the game's bundled Mono on Linux/Mac
-#endif
             this.BaseUrl = new Uri(baseUrl);
             this.Version = version;
         }
@@ -43,6 +41,34 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
             );
         }
 
+        /// <summary>Get the latest version for a mod.</summary>
+        /// <param name="updateKeys">The update keys to search.</param>
+        public ISemanticVersion GetLatestVersion(string[] updateKeys)
+        {
+            if (!updateKeys.Any())
+                return null;
+
+            // fetch update results
+            ModInfoModel[] results = this
+                .GetModInfo(updateKeys)
+                .Values
+                .Where(p => p.Error == null)
+                .ToArray();
+            if (!results.Any())
+                return null;
+
+            ISemanticVersion latest = null;
+            foreach (ModInfoModel result in results)
+            {
+                if (!SemanticVersion.TryParse(result.PreviewVersion ?? result.Version, out ISemanticVersion cur))
+                    continue;
+
+                if (latest == null || cur.IsNewerThan(latest))
+                    latest = cur;
+            }
+            return latest;
+        }
+
 
         /*********
         ** Private methods
-- 
cgit 


From 53a6833ab22fb41e909ed8ef50aa9262735818d9 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Wed, 6 Jun 2018 00:16:39 -0400
Subject: return file versions from Nexus in web API (#532)

---
 .../Framework/Clients/WebApi/ModInfoModel.cs                          | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
index e1a204c6..c8e296f0 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
@@ -9,10 +9,10 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The mod name.</summary>
         public string Name { get; set; }
 
-        /// <summary>The semantic version for the mod's latest release.</summary>
+        /// <summary>The mod's latest release number.</summary>
         public string Version { get; set; }
 
-        /// <summary>The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</summary>
+        /// <summary>The mod's latest optional release, if newer than <see cref="Version"/>.</summary>
         public string PreviewVersion { get; set; }
 
         /// <summary>The mod's web URL.</summary>
-- 
cgit 


From d401aff3307f6e2e1641610fdd912b572d6b04c1 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Tue, 19 Jun 2018 22:10:15 -0400
Subject: rewrite update checks (#551)

---
 .../Framework/Clients/WebApi/ModEntryModel.cs      | 30 ++++++++++++
 .../Framework/Clients/WebApi/ModInfoModel.cs       | 56 ----------------------
 .../Framework/Clients/WebApi/ModSeachModel.cs      | 15 +++---
 .../Clients/WebApi/ModSearchEntryModel.cs          | 34 +++++++++++++
 .../Framework/Clients/WebApi/WebApiClient.cs       | 39 ++-------------
 5 files changed, 76 insertions(+), 98 deletions(-)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
 delete mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
new file mode 100644
index 00000000..0f268231
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -0,0 +1,30 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Metadata about a mod.</summary>
+    public class ModEntryModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's unique ID (if known).</summary>
+        public string ID { get; set; }
+
+        /// <summary>The mod name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The mod's latest release number.</summary>
+        public string Version { get; set; }
+
+        /// <summary>The mod's web URL.</summary>
+        public string Url { get; set; }
+
+        /// <summary>The mod's latest optional release, if newer than <see cref="Version"/>.</summary>
+        public string PreviewVersion { get; set; }
+
+        /// <summary>The web URL to the mod's latest optional release, if newer than <see cref="Version"/>.</summary>
+        public string PreviewUrl { get; set; }
+
+        /// <summary>The errors that occurred while fetching update data.</summary>
+        public string[] Errors { get; set; } = new string[0];
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
deleted file mode 100644
index c8e296f0..00000000
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
+++ /dev/null
@@ -1,56 +0,0 @@
-namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
-{
-    /// <summary>Generic metadata about a mod.</summary>
-    public class ModInfoModel
-    {
-        /*********
-        ** Accessors
-        *********/
-        /// <summary>The mod name.</summary>
-        public string Name { get; set; }
-
-        /// <summary>The mod's latest release number.</summary>
-        public string Version { get; set; }
-
-        /// <summary>The mod's latest optional release, if newer than <see cref="Version"/>.</summary>
-        public string PreviewVersion { get; set; }
-
-        /// <summary>The mod's web URL.</summary>
-        public string Url { get; set; }
-
-        /// <summary>The error message indicating why the mod is invalid (if applicable).</summary>
-        public string Error { get; set; }
-
-
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an empty instance.</summary>
-        public ModInfoModel()
-        {
-            // needed for JSON deserialising
-        }
-
-        /// <summary>Construct an instance.</summary>
-        /// <param name="name">The mod name.</param>
-        /// <param name="version">The semantic version for the mod's latest release.</param>
-        /// <param name="previewVersion">The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</param>
-        /// <param name="url">The mod's web URL.</param>
-        /// <param name="error">The error message indicating why the mod is invalid (if applicable).</param>
-        public ModInfoModel(string name, string version, string url, string previewVersion = null, string error = null)
-        {
-            this.Name = name;
-            this.Version = version;
-            this.PreviewVersion = previewVersion;
-            this.Url = url;
-            this.Error = error; // mainly initialised here for the JSON deserialiser
-        }
-
-        /// <summary>Construct an instance.</summary>
-        /// <param name="error">The error message indicating why the mod is invalid.</param>
-        public ModInfoModel(string error)
-        {
-            this.Error = error;
-        }
-    }
-}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
index c0ee34ea..ffca32ca 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System;
 using System.Linq;
 
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
@@ -10,10 +10,11 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         ** Accessors
         *********/
         /// <summary>The namespaced mod keys to search.</summary>
+        [Obsolete]
         public string[] ModKeys { get; set; }
 
-        /// <summary>Whether to allow non-semantic versions, instead of returning an error for those.</summary>
-        public bool AllowInvalidVersions { get; set; }
+        /// <summary>The mods for which to find data.</summary>
+        public ModSearchEntryModel[] Mods { get; set; }
 
 
         /*********
@@ -26,12 +27,10 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         }
 
         /// <summary>Construct an instance.</summary>
-        /// <param name="modKeys">The namespaced mod keys to search.</param>
-        /// <param name="allowInvalidVersions">Whether to allow non-semantic versions, instead of returning an error for those.</param>
-        public ModSearchModel(IEnumerable<string> modKeys, bool allowInvalidVersions)
+        /// <param name="mods">The mods to search.</param>
+        public ModSearchModel(ModSearchEntryModel[] mods)
         {
-            this.ModKeys = modKeys.ToArray();
-            this.AllowInvalidVersions = allowInvalidVersions;
+            this.Mods = mods.ToArray();
         }
     }
 }
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs
new file mode 100644
index 00000000..bca47647
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSearchEntryModel.cs
@@ -0,0 +1,34 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Specifies the identifiers for a mod to match.</summary>
+    public class ModSearchEntryModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The unique mod ID.</summary>
+        public string ID { get; set; }
+
+        /// <summary>The namespaced mod update keys (if available).</summary>
+        public string[] UpdateKeys { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an empty instance.</summary>
+        public ModSearchEntryModel()
+        {
+            // needed for JSON deserialising
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="id">The unique mod ID.</param>
+        /// <param name="updateKeys">The namespaced mod update keys (if available).</param>
+        public ModSearchEntryModel(string id, string[] updateKeys)
+        {
+            this.ID = id;
+            this.UpdateKeys = updateKeys ?? new string[0];
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
index d94b0259..892dfeba 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Net;
 using Newtonsoft.Json;
 
@@ -31,44 +30,16 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
             this.Version = version;
         }
 
-        /// <summary>Get the latest SMAPI version.</summary>
-        /// <param name="modKeys">The mod keys for which to fetch the latest version.</param>
-        public IDictionary<string, ModInfoModel> GetModInfo(params string[] modKeys)
+        /// <summary>Get metadata about a set of mods from the web API.</summary>
+        /// <param name="mods">The mod keys for which to fetch the latest version.</param>
+        public IDictionary<string, ModEntryModel> GetModInfo(params ModSearchEntryModel[] mods)
         {
-            return this.Post<ModSearchModel, Dictionary<string, ModInfoModel>>(
+            return this.Post<ModSearchModel, Dictionary<string, ModEntryModel>>(
                 $"v{this.Version}/mods",
-                new ModSearchModel(modKeys, allowInvalidVersions: true)
+                new ModSearchModel(mods)
             );
         }
 
-        /// <summary>Get the latest version for a mod.</summary>
-        /// <param name="updateKeys">The update keys to search.</param>
-        public ISemanticVersion GetLatestVersion(string[] updateKeys)
-        {
-            if (!updateKeys.Any())
-                return null;
-
-            // fetch update results
-            ModInfoModel[] results = this
-                .GetModInfo(updateKeys)
-                .Values
-                .Where(p => p.Error == null)
-                .ToArray();
-            if (!results.Any())
-                return null;
-
-            ISemanticVersion latest = null;
-            foreach (ModInfoModel result in results)
-            {
-                if (!SemanticVersion.TryParse(result.PreviewVersion ?? result.Version, out ISemanticVersion cur))
-                    continue;
-
-                if (latest == null || cur.IsNewerThan(latest))
-                    latest = cur;
-            }
-            return latest;
-        }
-
 
         /*********
         ** Private methods
-- 
cgit 


From af92f2dc13c9a259c25a15d9bdfb80d73a0bec83 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 24 Jun 2018 15:08:58 -0400
Subject: add more verbose logs to simplify troubleshooting

---
 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
index 0f268231..e4ab168e 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -12,7 +12,7 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The mod name.</summary>
         public string Name { get; set; }
 
-        /// <summary>The mod's latest release number.</summary>
+        /// <summary>The mod's latest version number.</summary>
         public string Version { get; set; }
 
         /// <summary>The mod's web URL.</summary>
-- 
cgit 


From 3f5a5e54041a641e30fc5cc899046953d9763da4 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Thu, 28 Jun 2018 22:01:04 -0400
Subject: use more structured API response for update checks (#532)

---
 .../Framework/Clients/WebApi/ModEntryModel.cs      | 45 +++++++++++++++++++---
 .../Clients/WebApi/ModEntryVersionModel.cs         | 31 +++++++++++++++
 2 files changed, 70 insertions(+), 6 deletions(-)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
index e4ab168e..581a524c 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -1,3 +1,5 @@
+using System;
+
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 {
     /// <summary>Metadata about a mod.</summary>
@@ -12,19 +14,50 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The mod name.</summary>
         public string Name { get; set; }
 
+        /// <summary>The main version.</summary>
+        public ModEntryVersionModel Main { get; set; }
+
+        /// <summary>The latest optional version, if newer than <see cref="Main"/>.</summary>
+        public ModEntryVersionModel Optional { get; set; }
+
+        /// <summary>The errors that occurred while fetching update data.</summary>
+        public string[] Errors { get; set; } = new string[0];
+
+        /****
+        ** Backwards-compatible fields
+        ****/
         /// <summary>The mod's latest version number.</summary>
-        public string Version { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Main))]
+        internal string Version { get; private set; }
 
         /// <summary>The mod's web URL.</summary>
-        public string Url { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Main))]
+        internal string Url { get; private set; }
 
         /// <summary>The mod's latest optional release, if newer than <see cref="Version"/>.</summary>
-        public string PreviewVersion { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Optional))]
+        internal string PreviewVersion { get; private set; }
 
         /// <summary>The web URL to the mod's latest optional release, if newer than <see cref="Version"/>.</summary>
-        public string PreviewUrl { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Optional))]
+        internal string PreviewUrl { get; private set; }
 
-        /// <summary>The errors that occurred while fetching update data.</summary>
-        public string[] Errors { get; set; } = new string[0];
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Set backwards-compatible fields.</summary>
+        /// <param name="version">The requested API version.</param>
+        public void SetBackwardsCompatibility(ISemanticVersion version)
+        {
+            if (version.IsOlderThan("2.6-beta.19"))
+            {
+                this.Version = this.Main?.Version?.ToString();
+                this.Url = this.Main?.Url;
+
+                this.PreviewVersion = this.Optional?.Version?.ToString();
+                this.PreviewUrl = this.Optional?.Url;
+            }
+        }
     }
 }
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs
new file mode 100644
index 00000000..dadb8c10
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs
@@ -0,0 +1,31 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Metadata about a version.</summary>
+    public class ModEntryVersionModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The version number.</summary>
+        public ISemanticVersion Version { get; set; }
+
+        /// <summary>The mod page URL.</summary>
+        public string Url { get; set; }
+
+
+        /*********
+        ** 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)
+        {
+            this.Version = version;
+            this.Url = url;
+        }
+    }
+}
-- 
cgit 


From c9fedebaf3231a2d5a00a95ff1ffd3ac5dac4ae2 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Thu, 28 Jun 2018 22:30:34 -0400
Subject: add support for unofficial version in update checks (#532)

---
 .../Framework/Clients/WebApi/ModEntryModel.cs                          | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
index 581a524c..adfdfef9 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -20,6 +20,9 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The latest optional version, if newer than <see cref="Main"/>.</summary>
         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; }
+
         /// <summary>The errors that occurred while fetching update data.</summary>
         public string[] Errors { get; set; } = new string[0];
 
-- 
cgit 


From a0888e0ad1bf0ed38982d2aadf78c31d046b061b Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 29 Jun 2018 01:01:57 -0400
Subject: add optional extended metadata to mods API (#532)

---
 .../Framework/Clients/WebApi/ModEntryModel.cs      |  6 +-
 .../Clients/WebApi/ModExtendedMetadataModel.cs     | 77 ++++++++++++++++++++++
 .../Framework/Clients/WebApi/ModSeachModel.cs      |  3 +
 3 files changed, 83 insertions(+), 3 deletions(-)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
index adfdfef9..b311bd3b 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -11,9 +11,6 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The mod's unique ID (if known).</summary>
         public string ID { get; set; }
 
-        /// <summary>The mod name.</summary>
-        public string Name { get; set; }
-
         /// <summary>The main version.</summary>
         public ModEntryVersionModel Main { get; set; }
 
@@ -23,6 +20,9 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The latest unofficial version, if newer than <see cref="Main"/> and <see cref="Optional"/>.</summary>
         public ModEntryVersionModel Unofficial { get; set; }
 
+        /// <summary>Optional extended data which isn't needed for update checks.</summary>
+        public ModExtendedMetadataModel Metadata { get; set; }
+
         /// <summary>The errors that occurred while fetching update data.</summary>
         public string[] Errors { get; set; } = new string[0];
 
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
new file mode 100644
index 00000000..a716114b
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
@@ -0,0 +1,77 @@
+using System.Linq;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+using StardewModdingAPI.Toolkit.Framework.Clients.Wiki;
+using StardewModdingAPI.Toolkit.Framework.ModData;
+
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Extended metadata about a mod.</summary>
+    public class ModExtendedMetadataModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <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];
+
+        /// <summary>The mod's display name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The mod ID on Nexus.</summary>
+        public int? NexusID { get; set; }
+
+        /// <summary>The mod ID in the Chucklefish mod repo.</summary>
+        public int? ChucklefishID { get; set; }
+
+        /// <summary>The GitHub repository in the form 'owner/repo'.</summary>
+        public string GitHubRepo { get; set; }
+
+        /// <summary>The URL to a non-GitHub source repo.</summary>
+        public string CustomSourceUrl { get; set; }
+
+        /// <summary>The custom mod page URL (if applicable).</summary>
+        public string CustomUrl { get; set; }
+
+        /// <summary>The compatibility status.</summary>
+        [JsonConverter(typeof(StringEnumConverter))]
+        public WikiCompatibilityStatus? CompatibilityStatus { get; set; }
+
+        /// <summary>The human-readable summary of the compatibility status or workaround, without HTML formatitng.</summary>
+        public string CompatibilitySummary { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public ModExtendedMetadataModel() { }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="wiki">The mod metadata from the wiki (if available).</param>
+        /// <param name="db">The mod metadata from SMAPI's internal DB (if available).</param>
+        public ModExtendedMetadataModel(WikiCompatibilityEntry wiki, ModDataRecord db)
+        {
+            // wiki data
+            if (wiki != null)
+            {
+                this.ID = wiki.ID;
+                this.Name = wiki.Name;
+                this.NexusID = wiki.NexusID;
+                this.ChucklefishID = wiki.ChucklefishID;
+                this.GitHubRepo = wiki.GitHubRepo;
+                this.CustomSourceUrl = wiki.CustomSourceUrl;
+                this.CustomUrl = wiki.CustomUrl;
+                this.CompatibilityStatus = wiki.Status;
+                this.CompatibilitySummary = wiki.Summary;
+            }
+
+            // internal DB data
+            if (db != null)
+            {
+                this.ID = this.ID.Union(db.FormerIDs).ToArray();
+                this.Name = this.Name ?? db.DisplayName;
+            }
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
index ffca32ca..754cf02c 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
@@ -16,6 +16,9 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The mods for which to find data.</summary>
         public ModSearchEntryModel[] Mods { get; set; }
 
+        /// <summary>Whether to include extended metadata for each mod.</summary>
+        public bool IncludeExtendedMetadata { get; set; }
+
 
         /*********
         ** Public methods
-- 
cgit 


From 60b38666e29684650108031f08ca30bfe483ceab Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 29 Jun 2018 01:27:31 -0400
Subject: simplify mod API response structure (#532)

---
 .../Framework/Clients/WebApi/WebApiClient.cs                         | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
index 892dfeba..3e412fc3 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net;
 using Newtonsoft.Json;
 
@@ -34,10 +35,10 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <param name="mods">The mod keys for which to fetch the latest version.</param>
         public IDictionary<string, ModEntryModel> GetModInfo(params ModSearchEntryModel[] mods)
         {
-            return this.Post<ModSearchModel, Dictionary<string, ModEntryModel>>(
+            return this.Post<ModSearchModel, ModEntryModel[]>(
                 $"v{this.Version}/mods",
                 new ModSearchModel(mods)
-            );
+            ).ToDictionary(p => p.ID);
         }
 
 
-- 
cgit 


From c0370c54113bc95919affcbfbba8720a42b97a30 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 29 Jun 2018 01:50:06 -0400
Subject: add includeExtendedMetadata option to toolkit client (#532)

---
 .../Framework/Clients/WebApi/ModSeachModel.cs                        | 4 +++-
 .../Framework/Clients/WebApi/WebApiClient.cs                         | 5 +++--
 2 files changed, 6 insertions(+), 3 deletions(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
index 754cf02c..df0d8457 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
@@ -31,9 +31,11 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 
         /// <summary>Construct an instance.</summary>
         /// <param name="mods">The mods to search.</param>
-        public ModSearchModel(ModSearchEntryModel[] mods)
+        /// <param name="includeExtendedMetadata">Whether to include extended metadata for each mod.</param>
+        public ModSearchModel(ModSearchEntryModel[] mods, bool includeExtendedMetadata)
         {
             this.Mods = mods.ToArray();
+            this.IncludeExtendedMetadata = includeExtendedMetadata;
         }
     }
 }
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
index 3e412fc3..5bbe473e 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -33,11 +33,12 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 
         /// <summary>Get metadata about a set of mods from the web API.</summary>
         /// <param name="mods">The mod keys for which to fetch the latest version.</param>
-        public IDictionary<string, ModEntryModel> GetModInfo(params ModSearchEntryModel[] mods)
+        /// <param name="includeExtendedMetadata">Whether to include extended metadata for each mod.</param>
+        public IDictionary<string, ModEntryModel> GetModInfo(ModSearchEntryModel[] mods, bool includeExtendedMetadata = false)
         {
             return this.Post<ModSearchModel, ModEntryModel[]>(
                 $"v{this.Version}/mods",
-                new ModSearchModel(mods)
+                new ModSearchModel(mods, includeExtendedMetadata)
             ).ToDictionary(p => p.ID);
         }
 
-- 
cgit 


From 86428a31c2c275b32f08f149157f2fad78c8e488 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 29 Jun 2018 01:54:49 -0400
Subject: fix web API client not using correct JSON settings (#532)

---
 .../Framework/Clients/WebApi/WebApiClient.cs                        | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
index 5bbe473e..0ecd9664 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Net;
 using Newtonsoft.Json;
+using StardewModdingAPI.Toolkit.Serialisation;
 
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 {
@@ -18,6 +19,9 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The API version number.</summary>
         private readonly ISemanticVersion Version;
 
+        /// <summary>The JSON serializer settings to use.</summary>
+        private readonly JsonSerializerSettings JsonSettings = new JsonHelper().JsonSettings;
+
 
         /*********
         ** Public methods
@@ -62,7 +66,7 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
                 client.Headers["Content-Type"] = "application/json";
                 client.Headers["User-Agent"] = $"SMAPI/{this.Version}";
                 string response = client.UploadString(fullUrl, data);
-                return JsonConvert.DeserializeObject<TResult>(response);
+                return JsonConvert.DeserializeObject<TResult>(response, this.JsonSettings);
             }
         }
     }
-- 
cgit 


From 34c43f9f66b33c402947be5e84544e09cb048290 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 1 Jul 2018 12:23:03 -0400
Subject: add toolkit method for API data (#532)

---
 .../Framework/Clients/WebApi/ModExtendedMetadataModel.cs     | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
index a716114b..21376b36 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using System.Linq;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
@@ -73,5 +74,16 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
                 this.Name = this.Name ?? db.DisplayName;
             }
         }
+
+        /// <summary>Get update keys based on the metadata.</summary>
+        public IEnumerable<string> GetUpdateKeys()
+        {
+            if (this.NexusID.HasValue)
+                yield return $"Nexus:{this.NexusID}";
+            if (this.ChucklefishID.HasValue)
+                yield return $"Chucklefish:{this.ChucklefishID}";
+            if (this.GitHubRepo != null)
+                yield return $"GitHub:{this.GitHubRepo}";
+        }
     }
 }
-- 
cgit 


From 703acdc63f8543bab01f38ea68c28befb2911df8 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Mon, 2 Jul 2018 21:33:53 -0400
Subject: fix backwards-compatible API fields not being serialised (#532)

---
 .../Framework/Clients/WebApi/ModEntryModel.cs                        | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
index b311bd3b..f3f22b93 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -1,4 +1,5 @@
 using System;
+using Newtonsoft.Json;
 
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 {
@@ -31,18 +32,22 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         ****/
         /// <summary>The mod's latest version number.</summary>
         [Obsolete("Use " + nameof(ModEntryModel.Main))]
+        [JsonProperty]
         internal string Version { get; private set; }
 
         /// <summary>The mod's web URL.</summary>
         [Obsolete("Use " + nameof(ModEntryModel.Main))]
+        [JsonProperty]
         internal string Url { get; private set; }
 
         /// <summary>The mod's latest optional release, if newer than <see cref="Version"/>.</summary>
         [Obsolete("Use " + nameof(ModEntryModel.Optional))]
+        [JsonProperty]
         internal string PreviewVersion { get; private set; }
 
         /// <summary>The web URL to the mod's latest optional release, if newer than <see cref="Version"/>.</summary>
         [Obsolete("Use " + nameof(ModEntryModel.Optional))]
+        [JsonProperty]
         internal string PreviewUrl { get; private set; }
 
 
-- 
cgit