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/WebApi')

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