API and Variable Descriptor cleanup (#2480)

* chore: remove unused usings

* fix: add missing route attributes to AvatarController

* chore: relocate controllers

* chore: move everything out of the Net7/RestApi folders, adjust namespaces and cleanup uses as needed

* chore: delete old dead code

* fix: rename conflicting Type property and clean up the location of the variable descriptor types

fix: update Editor to refer to VariableDescriptor.DataType, fix straggler references to the old name
(I should have done a rename refactor, instead I got to use a temporary fake incorrectly typed `new Point Type` to find all of the missing updates in the server)

fix: make FixVariables Sqlite migration have the same name as the MySql migration

* chore: rename variable descriptor types

chore: generate no-op migrations for renaming the descriptor types

Author: pandinocoder

Framework/Intersect.Framework.Core/Descriptors/GameObjectType.cs

@@ -1,4 +1,5 @@
 using Intersect.Extensions;
+using Intersect.Framework.Core.GameObjects.Variables;
 using Intersect.GameObjects;
 using Intersect.GameObjects.Crafting;
 using Intersect.GameObjects.Events;
@@ -47,10 +48,10 @@ public enum GameObjectType
     [GameObjectInfo(typeof(EventBase), "events")]
     Event,
 
-    [GameObjectInfo(typeof(PlayerVariableBase), "player_variables")]
+    [GameObjectInfo(typeof(PlayerVariableDescriptor), "player_variables")]
     PlayerVariable,
 
-    [GameObjectInfo(typeof(ServerVariableBase), "server_variables")]
+    [GameObjectInfo(typeof(ServerVariableDescriptor), "server_variables")]
     ServerVariable,
 
     [GameObjectInfo(typeof(TilesetBase), "tilesets")]
@@ -59,9 +60,9 @@ public enum GameObjectType
     [GameObjectInfo(typeof(TimeBase), "")]
     Time,
 
-    [GameObjectInfo(typeof(GuildVariableBase), "guild_variables")]
+    [GameObjectInfo(typeof(GuildVariableDescriptor), "guild_variables")]
     GuildVariable,
 
-    [GameObjectInfo(typeof(UserVariableBase), "user_variables")]
+    [GameObjectInfo(typeof(UserVariableDescriptor), "user_variables")]
     UserVariable,
 }

Framework/Intersect.Framework.Core/Descriptors/GameObjectTypeExtensions.cs

@@ -1,8 +1,8 @@
 using System.Diagnostics.CodeAnalysis;
 using Intersect.Collections;
 using Intersect.Extensions;
+using Intersect.Framework.Core.GameObjects.Variables;
 using Intersect.GameObjects;
-using Intersect.GameObjects.Switches_and_Variables;
 using Intersect.Models;
 
 namespace Intersect.Enums;
@@ -70,7 +70,7 @@ public static IDatabaseObject CreateNew(this GameObjectType gameObjectType)
         return instance as IDatabaseObject;
     }
 
-    public static int ListIndex(this GameObjectType gameObjectType, Guid id, VariableDataType dataTypeFilter = 0)
+    public static int ListIndex(this GameObjectType gameObjectType, Guid id, VariableDataType dataTypeFilter = default)
     {
         var lookup = gameObjectType.GetLookup();
 
@@ -82,9 +82,9 @@ public static int ListIndex(this GameObjectType gameObjectType, Guid id, Variabl
         return lookup
             .OrderBy(kv => kv.Value?.Name)
             .Select(kv => kv.Value)
-            .OfType<IVariableBase>()
-            .Where(desc => desc.Type == dataTypeFilter)
-            .Select(desc => desc.Id)
+            .OfType<IVariableDescriptor>()
+            .Where(descriptor => dataTypeFilter == default || descriptor.DataType == dataTypeFilter)
+            .Select(descriptor => descriptor.Id)
             .ToList()
             .IndexOf(id);
     }
@@ -94,11 +94,11 @@ public static VariableDataType GetVariableType(this GameObjectType gameObjectTyp
         var lookup = gameObjectType.GetLookup();
 
         return lookup.ValueList
-                .OfType<IVariableBase>()
-                .FirstOrDefault(var => var.Id == variableDescriptorId)?.Type ?? 0;
+            .OfType<IVariableDescriptor>()
+            .FirstOrDefault(descriptor => descriptor.Id == variableDescriptorId)?.DataType ?? default;
     }
 
-    public static Guid IdFromList(this GameObjectType gameObjectType, int listIndex, VariableDataType dataTypeFilter = 0)
+    public static Guid IdFromList(this GameObjectType gameObjectType, int listIndex, VariableDataType dataTypeFilter = default)
     {
         var lookup = gameObjectType.GetLookup();
 
@@ -115,31 +115,31 @@ public static Guid IdFromList(this GameObjectType gameObjectType, int listIndex,
         return lookup
             .OrderBy(kv => kv.Value?.Name)
             .Select(kv => kv.Value)
-            .OfType<IVariableBase>()
-            .Where(desc => desc.Type == dataTypeFilter)
-            .Select(desc => desc.Id)
+            .OfType<IVariableDescriptor>()
+            .Where(descriptor => dataTypeFilter == default || descriptor.DataType == dataTypeFilter)
+            .Select(descriptor => descriptor.Id)
             .Skip(listIndex)
             .FirstOrDefault();
     }
 
-    public static string[] Names(this GameObjectType gameObjectType, VariableDataType dataTypeFilter = 0)
+    public static string[] Names(this GameObjectType gameObjectType, VariableDataType dataTypeFilter = default)
     {
         if (dataTypeFilter == 0)
         {
             return gameObjectType
                 .GetLookup()
                 .OrderBy(p => p.Value?.Name)
-                .Select(pair => pair.Value?.Name ?? PlayerVariableBase.Deleted)
+                .Select(pair => pair.Value?.Name ?? PlayerVariableDescriptor.Deleted)
                 .ToArray();
         }
 
         return gameObjectType
             .GetLookup()
             .Select(kv => kv.Value)
-            .OfType<IVariableBase>()
-            .Where(desc => desc.Type == dataTypeFilter)
-            .OrderBy(p => p?.Name)
-            .Select(pair => pair?.Name ?? PlayerVariableBase.Deleted)
+            .OfType<IVariableDescriptor>()
+            .Where(descriptor => dataTypeFilter == default || descriptor.DataType == dataTypeFilter)
+            .OrderBy(descriptor => descriptor.Name)
+            .Select(descriptor => descriptor.Name ?? PlayerVariableDescriptor.Deleted)
             .ToArray();
     }
 }

Framework/Intersect.Framework.Core/GameObjects/GuildVariableBase.cs

@@ -0,0 +1,17 @@
+using Newtonsoft.Json;
+
+namespace Intersect.Framework.Core.GameObjects.Variables;
+
+public partial class GuildVariableDescriptor : VariableDescriptor<GuildVariableDescriptor>, IVariableDescriptor
+{
+    [JsonConstructor]
+    public GuildVariableDescriptor(Guid id) : base(id)
+    {
+        Name = "New Guild Variable";
+    }
+
+    public GuildVariableDescriptor()
+    {
+        Name = "New Guild Variable";
+    }
+}

Framework/Intersect.Framework.Core/GameObjects/Switches and Variables/IVariableBase.cs

@@ -0,0 +1,18 @@
+using Intersect.Enums;
+using Intersect.Models;
+
+namespace Intersect.Framework.Core.GameObjects.Variables;
+
+public interface IVariableDescriptor : IDatabaseObject, IFolderable
+{
+    /// <summary>
+    /// The data type of the variable.
+    /// </summary>
+    VariableDataType DataType { get; set; }
+
+    /// <summary>
+    /// Identifier used for event chat variables to display the value of this variable/switch.
+    /// </summary>
+    /// <seealso href="https://www.ascensiongamedev.com/topic/749-event-text-variables/" />
+    string TextId { get; set; }
+}

Framework/Intersect.Framework.Core/GameObjects/Switches and Variables/PlayerVariableBase.cs

@@ -0,0 +1,17 @@
+using Newtonsoft.Json;
+
+namespace Intersect.Framework.Core.GameObjects.Variables;
+
+public partial class PlayerVariableDescriptor : VariableDescriptor<PlayerVariableDescriptor>, IVariableDescriptor
+{
+    [JsonConstructor]
+    public PlayerVariableDescriptor(Guid id) : base(id)
+    {
+        Name = "New Player Variable";
+    }
+
+    public PlayerVariableDescriptor()
+    {
+        Name = "New Player Variable";
+    }
+}

Framework/Intersect.Framework.Core/GameObjects/UserVariableBase.cs

@@ -1,32 +1,21 @@
 using System.ComponentModel.DataAnnotations.Schema;
-
-using Intersect.Enums;
-using Intersect.GameObjects.Switches_and_Variables;
-
 using Newtonsoft.Json;
 
-namespace Intersect.GameObjects;
+namespace Intersect.Framework.Core.GameObjects.Variables;
 
-public partial class ServerVariableBase : VariableDescriptor<ServerVariableBase>, IVariableBase
+public partial class ServerVariableDescriptor : VariableDescriptor<ServerVariableDescriptor>, IVariableDescriptor
 {
     [JsonConstructor]
-    public ServerVariableBase(Guid id) : base(id)
+    public ServerVariableDescriptor(Guid id) : base(id)
     {
         Name = "New Global Variable";
     }
 
-    public ServerVariableBase()
+    public ServerVariableDescriptor()
     {
         Name = "New Global Variable";
     }
 
-    //Identifier used for event chat variables to display the value of this variable/switch.
-    //See https://www.ascensiongamedev.com/topic/749-event-text-variables/ for usage info.
-    public string TextId { get; set; }
-
-    // TODO(0.8): Rename this to DataType
-    public new VariableDataType Type { get; set; } = VariableDataType.Boolean;
-
     [NotMapped]
     [JsonIgnore]
     public VariableValue Value { get; set; } = new();
@@ -52,7 +41,4 @@ private set
             }
         }
     }
-
-    /// <inheritdoc />
-    public string Folder { get; set; } = string.Empty;
 }