feat(itemdata): add Decay + Upkeep schema fields (6b)

Author: HandyS11

src/RustPlusBot.Features.ItemData/Data/ItemDataset.cs

@@ -11,28 +11,36 @@ public sealed record ItemDataset(int SchemaVersion, DatasetSources Sources, IRea
 /// <param name="RecycleAsOf">Recycle data source date.</param>
 /// <param name="CraftAsOf">Craft data source date.</param>
 /// <param name="ResearchAsOf">Research data source date.</param>
+/// <param name="DecayAsOf">Decay data source date.</param>
+/// <param name="UpkeepAsOf">Upkeep data source date.</param>
 public sealed record DatasetSources(
     DateOnly NamesAsOf,
     DateOnly RecycleAsOf,
     DateOnly CraftAsOf,
-    DateOnly ResearchAsOf);
+    DateOnly ResearchAsOf,
+    DateOnly DecayAsOf,
+    DateOnly UpkeepAsOf);
 
-/// <summary>One item, with all 6a calculator data inlined (null where not applicable).</summary>
+/// <summary>One item, with all calculator data inlined (null where not applicable).</summary>
 /// <param name="Id">The Rust item id.</param>
 /// <param name="Name">The display name.</param>
 /// <param name="StackSize">Max stack size.</param>
 /// <param name="DespawnSeconds">Despawn time in seconds, or null if it does not despawn / unknown.</param>
 /// <param name="Recycle">Recycler yield, or null if not recyclable.</param>
 /// <param name="Craft">Craft recipe, or null if not craftable.</param>
 /// <param name="Research">Research cost, or null if not researchable.</param>
+/// <param name="Decay">Decay timing, or null if the item does not decay / unknown.</param>
+/// <param name="Upkeep">Upkeep cost, or null if the item has no upkeep.</param>
 public sealed record ItemRecord(
     int Id,
     string Name,
     int StackSize,
     int? DespawnSeconds,
     RecycleYield? Recycle,
     CraftRecipe? Craft,
-    ResearchCost? Research);
+    ResearchCost? Research,
+    DecayInfo? Decay,
+    UpkeepCost? Upkeep);
 
 /// <summary>Recycler output for an item (6a covers the standard recycler only).</summary>
 /// <param name="Recycler">The yield entries produced by the standard recycler.</param>
@@ -58,3 +66,28 @@ public sealed record Ingredient(int ItemId, int Quantity);
 /// <summary>The research cost for an item.</summary>
 /// <param name="Scrap">The scrap cost to research.</param>
 public sealed record ResearchCost(int Scrap);
+
+/// <summary>Decay timing for an item/deployable/building block. All fields nullable — a field is
+/// populated only when RustLabs provides it. <paramref name="Seconds"/> is the base/default decay.</summary>
+/// <param name="Seconds">Base decay time in seconds.</param>
+/// <param name="OutsideSeconds">Decay time when placed outside, if distinct.</param>
+/// <param name="InsideSeconds">Decay time when placed inside, if distinct.</param>
+/// <param name="UnderwaterSeconds">Decay time when underwater, if distinct.</param>
+/// <param name="Hp">The item's hit points.</param>
+public sealed record DecayInfo(
+    int? Seconds,
+    int? OutsideSeconds,
+    int? InsideSeconds,
+    int? UnderwaterSeconds,
+    int? Hp);
+
+/// <summary>The upkeep cost to maintain a building block.</summary>
+/// <param name="Entries">The per-resource upkeep cost entries.</param>
+public sealed record UpkeepCost(IReadOnlyList<UpkeepEntry> Entries);
+
+/// <summary>One upkeep resource cost. <paramref name="QuantityMin"/> equals
+/// <paramref name="QuantityMax"/> for a single (non-range) quantity.</summary>
+/// <param name="ItemId">The resource item id.</param>
+/// <param name="QuantityMin">The lower bound of the cost.</param>
+/// <param name="QuantityMax">The upper bound of the cost.</param>
+public sealed record UpkeepEntry(int ItemId, int QuantityMin, int QuantityMax);

tests/RustPlusBot.Features.Commands.Tests/Formatting/ItemFormatterTests.cs

@@ -12,7 +12,7 @@ public sealed class ItemFormatterTests
     [Fact]
     public void ItemLine_IncludesNameAndStack()
     {
-        var item = new ItemRecord(1, "AK-47", 1, 3600, null, null, null);
+        var item = new ItemRecord(1, "AK-47", 1, 3600, null, null, null, null, null);
         var line = ItemLine.Format(item);
         Assert.Contains("AK-47", line, StringComparison.Ordinal);
         Assert.Contains("1", line, StringComparison.Ordinal);
@@ -22,7 +22,7 @@ public void ItemLine_IncludesNameAndStack()
     public void RecycleLine_ListsYields()
     {
         var item = new ItemRecord(1, "AK-47", 1, null,
-            new RecycleYield([new YieldEntry(-1059362949, 4, 1.0)]), null, null);
+            new RecycleYield([new YieldEntry(-1059362949, 4, 1.0)]), null, null, null, null);
         var line = RecycleLine.Format(item, _names);
         Assert.Contains("AK-47", line, StringComparison.Ordinal);
         Assert.Contains("4", line, StringComparison.Ordinal);
@@ -32,15 +32,15 @@ public void RecycleLine_ListsYields()
     public void CraftLine_ListsIngredients()
     {
         var item = new ItemRecord(1, "AK-47", 1, null, null,
-            new CraftRecipe([new Ingredient(-1059362949, 200)], 30.0, 3), null);
+            new CraftRecipe([new Ingredient(-1059362949, 200)], 30.0, 3), null, null, null);
         var line = CraftLine.Format(item, _names);
         Assert.Contains("200", line, StringComparison.Ordinal);
     }
 
     [Fact]
     public void ResearchLine_ShowsScrap()
     {
-        var item = new ItemRecord(1, "AK-47", 1, null, null, null, new ResearchCost(500));
+        var item = new ItemRecord(1, "AK-47", 1, null, null, null, new ResearchCost(500), null, null);
         var line = ResearchLine.Format(item);
         Assert.Contains("500", line, StringComparison.Ordinal);
     }

tests/RustPlusBot.Features.ItemData.Tests/EmbeddedItemDatabaseTests.cs

@@ -50,8 +50,8 @@ public void Parse_SucceedsOnMatchingSchemaVersion()
     [Fact]
     public void IndexById_DuplicateId_LastWins()
     {
-        var first = new ItemRecord(42, "First", 1, null, null, null, null);
-        var last = new ItemRecord(42, "Last", 1, null, null, null, null);
+        var first = new ItemRecord(42, "First", 1, null, null, null, null, null, null);
+        var last = new ItemRecord(42, "Last", 1, null, null, null, null, null, null);
         var index = EmbeddedItemDatabase.IndexById([first, last]);
         Assert.Equal("Last", index[42].Name);
     }

tests/RustPlusBot.Features.ItemData.Tests/ItemDatasetTests.cs

@@ -7,8 +7,25 @@ public sealed class ItemDatasetTests
     [Fact]
     public void ItemRecord_AllowsNullCalculatorData()
     {
-        var record = new ItemRecord(1, "Wood", 1000, null, null, null, null);
+        var record = new ItemRecord(1, "Wood", 1000, null, null, null, null, null, null);
         Assert.Equal("Wood", record.Name);
         Assert.Null(record.Recycle);
+        Assert.Null(record.Decay);
+        Assert.Null(record.Upkeep);
+    }
+
+    [Fact]
+    public void ItemRecord_CarriesDecayAndUpkeep()
+    {
+        var record = new ItemRecord(
+            2, "Wooden Door", 1, null, null, null, null,
+            new DecayInfo(900, null, null, null, 100),
+            new UpkeepCost([new UpkeepEntry(-151838493, 8, 25)]));
+
+        Assert.Equal(900, record.Decay!.Seconds);
+        Assert.Equal(100, record.Decay.Hp);
+        Assert.Equal(-151838493, record.Upkeep!.Entries[0].ItemId);
+        Assert.Equal(8, record.Upkeep.Entries[0].QuantityMin);
+        Assert.Equal(25, record.Upkeep.Entries[0].QuantityMax);
     }
 }

tests/RustPlusBot.Features.ItemData.Tests/ItemLookupTests.cs

@@ -5,10 +5,10 @@ namespace RustPlusBot.Features.ItemData.Tests;
 
 public sealed class ItemLookupTests
 {
-    private static readonly ItemRecord Ak = new(1, "AK-47", 1, null, null, null, null);
-    private static readonly ItemRecord Semi = new(2, "Semi-Automatic Rifle", 1, null, null, null, null);
-    private static readonly ItemRecord Wood = new(3, "Wood", 1000, null, null, null, null);
-    private static readonly ItemRecord Bag = new(4, "Sleeping Bag", 1, null, null, null, null);
+    private static readonly ItemRecord Ak = new(1, "AK-47", 1, null, null, null, null, null, null);
+    private static readonly ItemRecord Semi = new(2, "Semi-Automatic Rifle", 1, null, null, null, null, null, null);
+    private static readonly ItemRecord Wood = new(3, "Wood", 1000, null, null, null, null, null, null);
+    private static readonly ItemRecord Bag = new(4, "Sleeping Bag", 1, null, null, null, null, null, null);
     private static readonly IReadOnlyList<ItemRecord> All = [Ak, Semi, Wood, Bag];
 
     private static ItemMatch Resolve(string q) =>
@@ -64,8 +64,8 @@ public void MultipleSubstring_AmbiguousPrefixFirst()
     public void ExactNameCollision_ReturnsAmbiguousOrderedById()
     {
         // Two items share the same case-insensitive name; the one with the lower id should be first.
-        var recyclable = new ItemRecord(10, "Sunglasses", 1, null, new RecycleYield([]), null, null);
-        var notRecyclable = new ItemRecord(5, "Sunglasses", 1, null, null, null, null);
+        var recyclable = new ItemRecord(10, "Sunglasses", 1, null, new RecycleYield([]), null, null, null, null);
+        var notRecyclable = new ItemRecord(5, "Sunglasses", 1, null, null, null, null, null, null);
         IReadOnlyList<ItemRecord> items = [recyclable, notRecyclable];
         var match = ItemLookup.Resolve("sunglasses", id => items.FirstOrDefault(i => i.Id == id), items);
         var amb = Assert.IsType<ItemMatch.Ambiguous>(match);
@@ -79,9 +79,9 @@ public void ExactNameCollision_ReturnsAmbiguousOrderedById()
     public void ExactNameCollision_DoesNotFallThroughToSubstring()
     {
         // Even though there are 2 exact matches, the result must be Ambiguous (not a substring-ranked list).
-        var a = new ItemRecord(1, "Sunglasses", 1, null, null, null, null);
-        var b = new ItemRecord(2, "Sunglasses", 1, null, null, null, null);
-        var extra = new ItemRecord(3, "Cool Sunglasses", 1, null, null, null, null);
+        var a = new ItemRecord(1, "Sunglasses", 1, null, null, null, null, null, null);
+        var b = new ItemRecord(2, "Sunglasses", 1, null, null, null, null, null, null);
+        var extra = new ItemRecord(3, "Cool Sunglasses", 1, null, null, null, null, null, null);
         IReadOnlyList<ItemRecord> items = [a, b, extra];
         var match = ItemLookup.Resolve("Sunglasses", id => items.FirstOrDefault(i => i.Id == id), items);
         var amb = Assert.IsType<ItemMatch.Ambiguous>(match);
@@ -114,7 +114,8 @@ public void EmptyOrWhitespace_NotFound(string q)
     [Fact]
     public void Ambiguous_RespectsCap()
     {
-        var many = Enumerable.Range(1, 50).Select(i => new ItemRecord(i, $"Gun {i}", 1, null, null, null, null))
+        var many = Enumerable.Range(1, 50)
+            .Select(i => new ItemRecord(i, $"Gun {i}", 1, null, null, null, null, null, null))
             .ToList();
         var match = ItemLookup.Resolve("gun", id => many.FirstOrDefault(x => x.Id == id), many, cap: 10);
         var amb = Assert.IsType<ItemMatch.Ambiguous>(match);

tests/RustPlusBot.ItemData.Generator.Tests/DatasetValidatorTests.cs

@@ -7,11 +7,12 @@ namespace RustPlusBot.ItemData.Generator.Tests;
 public sealed class DatasetValidatorTests
 {
     private static ItemDataset Good() => new(1,
-        new DatasetSources(new(2026, 4, 8), new(2024, 9, 7), new(2024, 9, 7), new(2024, 9, 7)),
+        new DatasetSources(new(2026, 4, 8), new(2024, 9, 7), new(2024, 9, 7), new(2024, 9, 7), new(2024, 9, 7),
+            new(2024, 9, 7)),
         [
             new ItemRecord(1, "AK-47", 1, 3600,
-                new RecycleYield([new YieldEntry(2, 4, 1.0)]), null, null),
-            new ItemRecord(2, "Metal Fragments", 1000, null, null, null, null),
+                new RecycleYield([new YieldEntry(2, 4, 1.0)]), null, null, null, null),
+            new ItemRecord(2, "Metal Fragments", 1000, null, null, null, null, null, null),
         ]);
 
     /// <summary>A dataset with all referential constraints satisfied should produce no errors.</summary>
@@ -37,7 +38,7 @@ public void UnresolvableYieldId_isError()
         var bad = new ItemDataset(1, Good().Sources,
         [
             new ItemRecord(1, "AK-47", 1, null,
-                new RecycleYield([new YieldEntry(99999, 4, 1.0)]), null, null),
+                new RecycleYield([new YieldEntry(99999, 4, 1.0)]), null, null, null, null),
         ]);
         var errors = DatasetValidator.Validate(bad, new ValidationOptions(MinItemCount: 1));
         Assert.Contains(errors, e => e.Contains("99999", StringComparison.Ordinal));
@@ -50,7 +51,7 @@ public void UnresolvableCraftIngredientId_isError()
         var bad = new ItemDataset(1, Good().Sources,
         [
             new ItemRecord(1, "AK-47", 1, null, null,
-                new CraftRecipe([new Ingredient(88888, 100)], 30.0, 3), null),
+                new CraftRecipe([new Ingredient(88888, 100)], 30.0, 3), null, null, null),
         ]);
         var errors = DatasetValidator.Validate(bad, new ValidationOptions(MinItemCount: 1));
         Assert.Contains(errors, e => e.Contains("88888", StringComparison.Ordinal));

tools/RustPlusBot.ItemData.Generator/Program.cs

@@ -91,13 +91,13 @@ internal static int Main(string[] args)
                 var recycle = recycleYields.TryGetValue(id, out var ry) ? ry : null;
                 var craft = craftRecipes.TryGetValue(id, out var cr) ? cr : null;
                 var research = researchCosts.TryGetValue(id, out var rc) ? rc : null;
-                return new ItemRecord(id, name, stackSize, despawn, recycle, craft, research);
+                return new ItemRecord(id, name, stackSize, despawn, recycle, craft, research, null, null);
             })
             .ToList();
 
         var dataset = new ItemDataset(
             1,
-            new DatasetSources(NamesAsOf, RecycleAsOf, CraftAsOf, ResearchAsOf),
+            new DatasetSources(NamesAsOf, RecycleAsOf, CraftAsOf, ResearchAsOf, new(2024, 9, 7), new(2024, 9, 7)),
             items);
 
         var validationOptions = new ValidationOptions(MinItemCount: minItems);