Merge pull request #876 from jltaylor-us/update-manifest

Add `UpdateManifest` update keys

3 files changed, 93 insertions, 0 deletions

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..ead5c229
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
@@ -0,0 +1,35 @@
+using System;
+
+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? ModPageUrl { 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="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? modPageUrl, UpdateManifestVersionModel[]? versions)
+        {
+            this.Name = name;
+            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
new file mode 100644
index 00000000..5ccd31b0
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
@@ -0,0 +1,30 @@
+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. 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; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <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)
+        {
+            this.Format = format;
+            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
new file mode 100644
index 00000000..6678f5eb
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
@@ -0,0 +1,28 @@
+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 mod page URL from which to download updates, if different from <see cref="UpdateManifestModModel.ModPageUrl"/>.</summary>
+        public string? ModPageUrl { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="version">The mod's semantic version.</param>
+        /// <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.ModPageUrl = modPageUrl;
+        }
+    }
+}