Add routes for authors, tags, licences, object packs and sc5 packs (#162)

LeftofZen · web-flow · commit c581d7d49517 · 2025-01-24T10:25:58.000+11:00
Add routes for authors, tags, licences, object packs and sc5 packs
diff --git a/DatabaseExporter/Program.cs b/DatabaseExporter/Program.cs
@@ -49,7 +49,7 @@
 
 foreach (var o in db.SC5FilePacks
 		.Include(l => l.Licence)
-		.Select(x => new ExpandedTblPack<TblSC5FilePack>(x, x.Authors, x.Tags))
+		.Select(x => new ExpandedTblPack<TblSC5FilePack, TblSC5File>(x, x.SC5Files, x.Authors, x.Tags))
 		.ToList()
 		.OrderBy(x => x.Pack.Name))
 {
@@ -76,7 +76,7 @@
 
 foreach (var o in db.ObjectPacks
 		.Include(l => l.Licence)
-		.Select(x => new ExpandedTblPack<TblLocoObjectPack>(x, x.Authors, x.Tags))
+		.Select(x => new ExpandedTblPack<TblLocoObjectPack, TblLocoObject>(x, x.Objects, x.Authors, x.Tags))
 		.ToList()
 		.OrderBy(x => x.Pack.Name))
 {
diff --git a/Definitions/DTO/DtoAuthorEntry.cs b/Definitions/DTO/DtoAuthorEntry.cs
@@ -0,0 +1,6 @@
+﻿namespace OpenLoco.Definitions.DTO
+{
+	public record DtoAuthorEntry(
+		int Id,
+		string Name);
+}
diff --git a/Definitions/DTO/DtoDatObjectWithMetadata.cs b/Definitions/DTO/DtoDatObjectWithMetadata.cs
@@ -4,7 +4,7 @@
 
 namespace OpenLoco.Definitions.DTO
 {
-	public record DtoDatObjectWithMetadata(
+	public record DtoObjectDescriptorWithMetadata(
 		int Id,
 		string UniqueName,
 		string DatName,
diff --git a/Definitions/DTO/DtoExtensions.cs b/Definitions/DTO/DtoExtensions.cs
@@ -0,0 +1,81 @@
+using OpenLoco.Definitions.Database;
+using OpenLoco.Definitions.SourceData;
+
+namespace OpenLoco.Definitions.DTO
+{
+	public static class DtoExtensions
+	{
+		public static DtoObjectDescriptor ToDtoDescriptor(this TblLocoObject x)
+			=> new(
+				x.Id,
+				x.DatName,
+				x.DatChecksum,
+				x.ObjectSource,
+				x.ObjectType,
+				x.VehicleType,
+				x.Availability,
+				x.Name,
+				x.Description,
+				x.CreationDate,
+				x.LastEditDate,
+				x.UploadDate
+				);
+
+		public static DtoObjectEntry ToDtoEntry(this TblLocoObject x)
+			=> new(
+				x.Id,
+				x.DatName,
+				x.DatChecksum);
+
+		public static DtoScenarioEntry ToDtoEntry(this TblSC5File x)
+			=> new(
+				x.Id,
+				x.Name);
+
+		public static DtoItemPackEntry ToDtoEntry(this TblSC5FilePack x)
+			=> new(
+				x.Id,
+				x.Name,
+				x.Description,
+				x.CreationDate,
+				x.LastEditDate,
+				x.UploadDate,
+				x.Licence);
+
+		public static DtoItemPackEntry ToDtoEntry(this TblLocoObjectPack x)
+			=> new(
+				x.Id,
+				x.Name,
+				x.Description,
+				x.CreationDate,
+				x.LastEditDate,
+				x.UploadDate,
+				x.Licence);
+
+		public static DtoItemPackDescriptor<DtoObjectEntry> ToDtoDescriptor(this ExpandedTblPack<TblLocoObjectPack, TblLocoObject> x)
+			=> new(
+				x.Pack.Id,
+				x.Pack.Name,
+				x.Pack.Description,
+				x.Items.Select(x => x.ToDtoEntry()).ToList(),
+				x.Authors,
+				x.Pack.CreationDate,
+				x.Pack.LastEditDate,
+				x.Pack.UploadDate,
+				x.Tags,
+				x.Pack.Licence);
+
+		public static DtoItemPackDescriptor<DtoScenarioEntry> ToDtoDescriptor(this ExpandedTblPack<TblSC5FilePack, TblSC5File> x)
+			=> new(
+				x.Pack.Id,
+				x.Pack.Name,
+				x.Pack.Description,
+				x.Items.Select(x => x.ToDtoEntry()).ToList(),
+				x.Authors,
+				x.Pack.CreationDate,
+				x.Pack.LastEditDate,
+				x.Pack.UploadDate,
+				x.Tags,
+				x.Pack.Licence);
+	}
+}
diff --git a/Definitions/DTO/DtoItemPackDescriptor.cs b/Definitions/DTO/DtoItemPackDescriptor.cs
@@ -0,0 +1,16 @@
+﻿using OpenLoco.Definitions.Database;
+
+namespace OpenLoco.Definitions.DTO
+{
+	public record DtoItemPackDescriptor<T>(
+		int Id,
+		string Name,
+		string? Description,
+		ICollection<T> Items,
+		ICollection<TblAuthor> Authors,
+		DateTimeOffset? CreationDate,
+		DateTimeOffset? LastEditDate,
+		DateTimeOffset UploadDate,
+		ICollection<TblTag> Tags,
+		TblLicence? Licence);
+}
diff --git a/Definitions/DTO/DtoItemPackEntry.cs b/Definitions/DTO/DtoItemPackEntry.cs
@@ -0,0 +1,13 @@
+﻿using OpenLoco.Definitions.Database;
+
+namespace OpenLoco.Definitions.DTO
+{
+	public record DtoItemPackEntry(
+		int Id,
+		string Name,
+		string? Description,
+		DateTimeOffset? CreationDate,
+		DateTimeOffset? LastEditDate,
+		DateTimeOffset UploadDate,
+		TblLicence? Licence);
+}
diff --git a/Definitions/DTO/DtoLicenceEntry.cs b/Definitions/DTO/DtoLicenceEntry.cs
@@ -0,0 +1,7 @@
+﻿namespace OpenLoco.Definitions.DTO
+{
+	public record DtoLicenceEntry(
+		int Id,
+		string Name,
+		string LicenceText);
+}
diff --git a/Definitions/DTO/DtoObjectDescriptor.cs b/Definitions/DTO/DtoObjectDescriptor.cs
@@ -3,7 +3,7 @@
 
 namespace OpenLoco.Definitions.DTO
 {
-	public record DtoObjectIndexEntry(
+	public record DtoObjectDescriptor(
 		int Id,
 		string DatName,
 		uint DatChecksum,
diff --git a/Definitions/DTO/DtoObjectEntry.cs b/Definitions/DTO/DtoObjectEntry.cs
@@ -0,0 +1,7 @@
+﻿namespace OpenLoco.Definitions.DTO
+{
+	public record DtoObjectEntry(
+		int Id,
+		string DatName,
+		uint DatChecksum);
+}
diff --git a/Definitions/DTO/DtoScenarioEntry.cs b/Definitions/DTO/DtoScenarioEntry.cs
@@ -0,0 +1,6 @@
+﻿namespace OpenLoco.Definitions.DTO
+{
+	public record DtoScenarioEntry(
+		int Id,
+		string Name);
+}
diff --git a/Definitions/DTO/DtoScenarioIndexEntry.cs b/Definitions/DTO/DtoScenarioIndexEntry.cs
diff --git a/Definitions/DTO/DtoTagEntry.cs b/Definitions/DTO/DtoTagEntry.cs
@@ -0,0 +1,6 @@
+﻿namespace OpenLoco.Definitions.DTO
+{
+	public record DtoTagEntry(
+		int Id,
+		string Name);
+}
diff --git a/Definitions/SourceData/ExpandedTblLocoObject.cs b/Definitions/SourceData/ExpandedTblLocoObject.cs
@@ -5,5 +5,5 @@ namespace OpenLoco.Definitions.SourceData
 	// this must be done because eager-loading related many-to-many data in entity framework is recursive and cannot be turned off...
 	public record ExpandedTbl<T, TPack>(T Object, ICollection<TblAuthor> Authors, ICollection<TblTag> Tags, ICollection<TPack> Packs);
 
-	public record ExpandedTblPack<T>(T Pack, ICollection<TblAuthor> Authors, ICollection<TblTag> Tags);
+	public record ExpandedTblPack<T, TPackItem>(T Pack, ICollection<TPackItem> Items, ICollection<TblAuthor> Authors, ICollection<TblTag> Tags);
 }
diff --git a/Definitions/Web/Client.cs b/Definitions/Web/Client.cs
@@ -9,20 +9,20 @@ public static class Client
 	{
 		public const string Version = "v1";
 
-		public static async Task<IEnumerable<DtoObjectIndexEntry>> GetObjectListAsync(HttpClient client, ILogger? logger = null)
-			=> await SendRequestAsync<IEnumerable<DtoObjectIndexEntry>?>(client, Routes.ListObjects, logger) ?? [];
+		public static async Task<IEnumerable<DtoObjectDescriptor>> GetObjectListAsync(HttpClient client, ILogger? logger = null)
+			=> await SendRequestAsync<IEnumerable<DtoObjectDescriptor>?>(client, Routes.ListObjects, logger) ?? [];
 
-		public static async Task<DtoDatObjectWithMetadata?> GetDatAsync(HttpClient client, string objectName, uint checksum, bool returnObjBytes, ILogger? logger = null)
-			=> await SendRequestAsync<DtoDatObjectWithMetadata?>(client, Routes.GetDat + $"?{nameof(objectName)}={objectName}&{nameof(checksum)}={checksum}&{nameof(returnObjBytes)}={returnObjBytes}", logger);
+		public static async Task<DtoObjectDescriptorWithMetadata?> GetDatAsync(HttpClient client, string objectName, uint checksum, bool returnObjBytes, ILogger? logger = null)
+			=> await SendRequestAsync<DtoObjectDescriptorWithMetadata?>(client, Routes.GetDat + $"?{nameof(objectName)}={objectName}&{nameof(checksum)}={checksum}&{nameof(returnObjBytes)}={returnObjBytes}", logger);
 
-		public static async Task<DtoDatObjectWithMetadata?> GetObjectAsync(HttpClient client, int uniqueObjectId, bool returnObjBytes, ILogger? logger = null)
-			=> await SendRequestAsync<DtoDatObjectWithMetadata?>(client, Routes.GetObject + $"?{nameof(uniqueObjectId)}={uniqueObjectId}&{nameof(returnObjBytes)}={returnObjBytes}", logger);
+		public static async Task<DtoObjectDescriptorWithMetadata?> GetObjectAsync(HttpClient client, int uniqueObjectId, bool returnObjBytes, ILogger? logger = null)
+			=> await SendRequestAsync<DtoObjectDescriptorWithMetadata?>(client, Routes.GetObject + $"?{nameof(uniqueObjectId)}={uniqueObjectId}&{nameof(returnObjBytes)}={returnObjBytes}", logger);
 
-		public static async Task<DtoDatObjectWithMetadata?> GetDatFileAsync(HttpClient client, string objectName, uint checksum, ILogger? logger = null)
-			=> await SendRequestAsync<DtoDatObjectWithMetadata?>(client, Routes.GetDatFile + $"?{nameof(objectName)}={objectName}&{nameof(checksum)}={checksum}", logger);
+		public static async Task<DtoObjectDescriptorWithMetadata?> GetDatFileAsync(HttpClient client, string objectName, uint checksum, ILogger? logger = null)
+			=> await SendRequestAsync<DtoObjectDescriptorWithMetadata?>(client, Routes.GetDatFile + $"?{nameof(objectName)}={objectName}&{nameof(checksum)}={checksum}", logger);
 
-		public static async Task<DtoDatObjectWithMetadata?> GetObjectFileAsync(HttpClient client, int uniqueObjectId, ILogger? logger = null)
-			=> await SendRequestAsync<DtoDatObjectWithMetadata?>(client, Routes.GetDatFile + $"?{nameof(uniqueObjectId)}={uniqueObjectId}", logger);
+		public static async Task<DtoObjectDescriptorWithMetadata?> GetObjectFileAsync(HttpClient client, int uniqueObjectId, ILogger? logger = null)
+			=> await SendRequestAsync<DtoObjectDescriptorWithMetadata?>(client, Routes.GetDatFile + $"?{nameof(uniqueObjectId)}={uniqueObjectId}", logger);
 
 		static async Task<T?> SendRequestAsync<T>(HttpClient client, string route, ILogger? logger = null)
 		{
diff --git a/Definitions/Web/Routes.cs b/Definitions/Web/Routes.cs
@@ -11,9 +11,19 @@ public static class Routes
 		public const string GetObjectFile = "/objects/getobjectfile";
 		public const string GetObjectImages = "/objects/getobjectimages";
 
+		public const string ListObjectPacks = "/objectpacks/list";
+		public const string GetObjectPack = "/objectpacks/getpack";
+
 		public const string ListScenarios = "/scenarios/list";
 		public const string GetScenario = "/scenarios/getscenario";
 
+		public const string ListSC5FilePacks = "/sc5filepacks/list";
+		public const string GetSC5FilePack = "/sc5filepacks/getpack";
+
+		public const string ListAuthors = "/authors/list";
+		public const string ListLicences = "/licences/list";
+		public const string ListTags = "/tags/list";
+
 		// POST
 		public const string UploadDat = "/objects/uploaddat";
 		public const string UploadObject = "/objects/uploadobject";
diff --git a/Gui/Models/ObjectEditorModel.cs b/Gui/Models/ObjectEditorModel.cs
@@ -30,7 +30,7 @@ public class ObjectEditorModel
 
 		public ObjectIndex? ObjectIndexOnline { get; set; }
 
-		public Dictionary<int, DtoDatObjectWithMetadata> OnlineCache { get; } = [];
+		public Dictionary<int, DtoObjectDescriptorWithMetadata> OnlineCache { get; } = [];
 
 		public PaletteMap PaletteMap { get; set; }
 
diff --git a/ObjectService/Program.cs b/ObjectService/Program.cs
@@ -116,9 +116,20 @@ static void MapRoutes(RouteGroupBuilder routeGroup, Server server)
 	_ = routeGroup.MapGet(Routes.GetObject, server.GetObject);
 	_ = routeGroup.MapGet(Routes.GetObjectFile, server.GetObjectFile);
 	_ = routeGroup.MapGet(Routes.GetObjectImages, server.GetObjectImages);
+
+	_ = routeGroup.MapGet(Routes.ListObjectPacks, server.ListObjectPacks);
+	_ = routeGroup.MapGet(Routes.GetObjectPack, server.GetObjectPack);
+
 	_ = routeGroup.MapGet(Routes.ListScenarios, server.ListScenarios);
 	_ = routeGroup.MapGet(Routes.GetScenario, server.GetScenario);
 
+	_ = routeGroup.MapGet(Routes.ListSC5FilePacks, server.ListSC5FilePacks);
+	_ = routeGroup.MapGet(Routes.GetSC5FilePack, server.GetSC5FilePack);
+
+	_ = routeGroup.MapGet(Routes.ListAuthors, server.ListAuthors);
+	_ = routeGroup.MapGet(Routes.ListLicences, server.ListLicences);
+	_ = routeGroup.MapGet(Routes.ListTags, server.ListTags);
+
 	// POST
 	_ = routeGroup.MapPost(Routes.UploadDat, server.UploadDat);
 	_ = routeGroup.MapPost(Routes.UploadObject, server.UploadObject);
diff --git a/ObjectService/Server.cs b/ObjectService/Server.cs

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace OpenLoco.Definitions.DTO`
`6`	`6`	`{`
`7`		`- public record DtoDatObjectWithMetadata(`
	`7`	`+ public record DtoObjectDescriptorWithMetadata(`
`8`	`8`	`int Id,`
`9`	`9`	`string UniqueName,`
`10`	`10`	`string DatName,`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace OpenLoco.Definitions.DTO`
`5`	`5`	`{`
`6`		`- public record DtoObjectIndexEntry(`
	`6`	`+ public record DtoObjectDescriptor(`
`7`	`7`	`int Id,`
`8`	`8`	`string DatName,`
`9`	`9`	`uint DatChecksum,`