Merge branch 'develop' into stable

1 files changed, 54 insertions, 0 deletions

diff --git a/src/StardewModdingAPI.Toolkit/Framework/ModData/ModDataRecordVersionedFields.cs b/src/StardewModdingAPI.Toolkit/Framework/ModData/ModDataRecordVersionedFields.cs
new file mode 100644
index 00000000..237f2c66
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/ModData/ModDataRecordVersionedFields.cs
@@ -0,0 +1,54 @@
+namespace StardewModdingAPI.Toolkit.Framework.ModData
+{
+    /// <summary>The versioned fields from a <see cref="ModDataRecord"/> for a specific manifest.</summary>
+    public class ModDataRecordVersionedFields
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The underlying data record.</summary>
+        public ModDataRecord DataRecord { get; set; }
+
+        /// <summary>The default mod name to display when the name isn't available (e.g. during dependency checks).</summary>
+        public string DisplayName { get; set; }
+
+        /// <summary>The update key to apply.</summary>
+        public string UpdateKey { get; set; }
+
+        /// <summary>The alternative URL the player can check for an updated version.</summary>
+        public string AlternativeUrl { get; set; }
+
+        /// <summary>The predefined compatibility status.</summary>
+        public ModStatus Status { get; set; } = ModStatus.None;
+
+        /// <summary>A reason phrase for the <see cref="Status"/>, or <c>null</c> to use the default reason.</summary>
+        public string StatusReasonPhrase { get; set; }
+
+        /// <summary>The upper version for which the <see cref="Status"/> applies (if any).</summary>
+        public ISemanticVersion StatusUpperVersion { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get a semantic local version for update checks.</summary>
+        /// <param name="version">The remote version to normalise.</param>
+        public ISemanticVersion GetLocalVersionForUpdateChecks(ISemanticVersion version)
+        {
+            return this.DataRecord.GetLocalVersionForUpdateChecks(version);
+        }
+
+        /// <summary>Get a semantic remote version for update checks.</summary>
+        /// <param name="version">The remote version to normalise.</param>
+        public ISemanticVersion GetRemoteVersionForUpdateChecks(ISemanticVersion version)
+        {
+            if (version == null)
+                return null;
+
+            string rawVersion = this.DataRecord.GetRemoteVersionForUpdateChecks(version.ToString());
+            return rawVersion != null
+                ? new SemanticVersion(rawVersion)
+                : version;
+        }
+    }
+}