NEO-103: Add GET /game/world/encounter-definitions API.
Expose schema v1 encounter list with nested completionCriteria and rewardTable summary via encounter and reward-table registries.pull/142/head
parent
62e6bfdf0a
commit
9b48ec5f39
|
|
@ -0,0 +1,50 @@
|
||||||
|
using System.Linq;
|
||||||
|
using System.Net;
|
||||||
|
using System.Net.Http.Json;
|
||||||
|
using NeonSprawl.Server.Game.Encounters;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace NeonSprawl.Server.Tests.Game.Encounters;
|
||||||
|
|
||||||
|
public class EncounterDefinitionsWorldApiTests
|
||||||
|
{
|
||||||
|
/// <summary>Frozen prototype encounter id. Keep in sync with Bruno.</summary>
|
||||||
|
public const string PrototypeCombatPocket = "prototype_combat_pocket";
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task GetEncounterDefinitions_ShouldReturnSchemaV1_WithFrozenEncounterAndNestedRewardTable()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var factory = new InMemoryWebApplicationFactory();
|
||||||
|
var client = factory.CreateClient();
|
||||||
|
// Act
|
||||||
|
var response = await client.GetAsync("/game/world/encounter-definitions");
|
||||||
|
// Assert
|
||||||
|
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
||||||
|
var body = await response.Content.ReadFromJsonAsync<EncounterDefinitionsListResponse>();
|
||||||
|
Assert.NotNull(body);
|
||||||
|
Assert.Equal(EncounterDefinitionsListResponse.CurrentSchemaVersion, body!.SchemaVersion);
|
||||||
|
Assert.NotNull(body.Encounters);
|
||||||
|
Assert.Single(body.Encounters);
|
||||||
|
|
||||||
|
var encounter = body.Encounters[0];
|
||||||
|
Assert.Equal(PrototypeCombatPocket, encounter.Id);
|
||||||
|
Assert.Equal("Prototype Combat Pocket", encounter.DisplayName);
|
||||||
|
Assert.NotNull(encounter.CompletionCriteria);
|
||||||
|
Assert.Equal("defeat_all_targets", encounter.CompletionCriteria.Kind);
|
||||||
|
Assert.Equal(
|
||||||
|
["prototype_npc_melee", "prototype_npc_ranged", "prototype_npc_elite"],
|
||||||
|
encounter.RequiredNpcInstanceIds);
|
||||||
|
|
||||||
|
Assert.NotNull(encounter.RewardTable);
|
||||||
|
Assert.Equal("prototype_combat_pocket_clear", encounter.RewardTable.Id);
|
||||||
|
Assert.Equal("Prototype Combat Pocket Clear", encounter.RewardTable.DisplayName);
|
||||||
|
Assert.Equal(2, encounter.RewardTable.FixedGrants.Count);
|
||||||
|
|
||||||
|
var scrapGrant = encounter.RewardTable.FixedGrants.Single(g => g.ItemId == "scrap_metal_bulk");
|
||||||
|
Assert.Equal(10, scrapGrant.Quantity);
|
||||||
|
|
||||||
|
var tokenGrant = encounter.RewardTable.FixedGrants.Single(g => g.ItemId == "contract_handoff_token");
|
||||||
|
Assert.Equal(1, tokenGrant.Quantity);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
using System.Text.Json.Serialization;
|
||||||
|
|
||||||
|
namespace NeonSprawl.Server.Game.Encounters;
|
||||||
|
|
||||||
|
/// <summary>JSON body for <c>GET /game/world/encounter-definitions</c> (NEO-103).</summary>
|
||||||
|
public sealed class EncounterDefinitionsListResponse
|
||||||
|
{
|
||||||
|
public const int CurrentSchemaVersion = 1;
|
||||||
|
|
||||||
|
[JsonPropertyName("schemaVersion")]
|
||||||
|
public int SchemaVersion { get; init; } = CurrentSchemaVersion;
|
||||||
|
|
||||||
|
/// <summary>Loaded encounters ordered by stable <c>id</c> (ordinal), matching <see cref="IEncounterDefinitionRegistry.GetDefinitionsInIdOrder"/>.</summary>
|
||||||
|
[JsonPropertyName("encounters")]
|
||||||
|
public required IReadOnlyList<EncounterDefinitionJson> Encounters { get; init; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>One row in the read-only encounter definition projection.</summary>
|
||||||
|
public sealed class EncounterDefinitionJson
|
||||||
|
{
|
||||||
|
[JsonPropertyName("id")]
|
||||||
|
public required string Id { get; init; }
|
||||||
|
|
||||||
|
[JsonPropertyName("displayName")]
|
||||||
|
public required string DisplayName { get; init; }
|
||||||
|
|
||||||
|
[JsonPropertyName("completionCriteria")]
|
||||||
|
public required EncounterCompletionCriteriaJson CompletionCriteria { get; init; }
|
||||||
|
|
||||||
|
[JsonPropertyName("requiredNpcInstanceIds")]
|
||||||
|
public required IReadOnlyList<string> RequiredNpcInstanceIds { get; init; }
|
||||||
|
|
||||||
|
[JsonPropertyName("rewardTable")]
|
||||||
|
public required EncounterRewardTableJson RewardTable { get; init; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Completion rule summary for one encounter row.</summary>
|
||||||
|
public sealed class EncounterCompletionCriteriaJson
|
||||||
|
{
|
||||||
|
[JsonPropertyName("kind")]
|
||||||
|
public required string Kind { get; init; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Nested reward table summary linked from an encounter row.</summary>
|
||||||
|
public sealed class EncounterRewardTableJson
|
||||||
|
{
|
||||||
|
[JsonPropertyName("id")]
|
||||||
|
public required string Id { get; init; }
|
||||||
|
|
||||||
|
[JsonPropertyName("displayName")]
|
||||||
|
public required string DisplayName { get; init; }
|
||||||
|
|
||||||
|
[JsonPropertyName("fixedGrants")]
|
||||||
|
public required IReadOnlyList<EncounterRewardGrantJson> FixedGrants { get; init; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>One deterministic item grant in a nested reward table summary.</summary>
|
||||||
|
public sealed class EncounterRewardGrantJson
|
||||||
|
{
|
||||||
|
[JsonPropertyName("itemId")]
|
||||||
|
public required string ItemId { get; init; }
|
||||||
|
|
||||||
|
[JsonPropertyName("quantity")]
|
||||||
|
public required int Quantity { get; init; }
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,68 @@
|
||||||
|
namespace NeonSprawl.Server.Game.Encounters;
|
||||||
|
|
||||||
|
/// <summary>Maps <c>GET /game/world/encounter-definitions</c> (NEO-103).</summary>
|
||||||
|
public static class EncounterDefinitionsWorldApi
|
||||||
|
{
|
||||||
|
public static WebApplication MapEncounterDefinitionsWorldApi(this WebApplication app)
|
||||||
|
{
|
||||||
|
app.MapGet(
|
||||||
|
"/game/world/encounter-definitions",
|
||||||
|
(IEncounterDefinitionRegistry encounterRegistry, IRewardTableDefinitionRegistry rewardTableRegistry) =>
|
||||||
|
{
|
||||||
|
var defs = encounterRegistry.GetDefinitionsInIdOrder();
|
||||||
|
var encounters = new List<EncounterDefinitionJson>(defs.Count);
|
||||||
|
foreach (var d in defs)
|
||||||
|
{
|
||||||
|
if (!rewardTableRegistry.TryGetDefinition(d.RewardTableId, out var rewardTable) ||
|
||||||
|
rewardTable is null)
|
||||||
|
{
|
||||||
|
throw new InvalidOperationException(
|
||||||
|
$"Encounter definition '{d.Id}' references reward table '{d.RewardTableId}' that is not in the loaded catalog.");
|
||||||
|
}
|
||||||
|
|
||||||
|
encounters.Add(
|
||||||
|
new EncounterDefinitionJson
|
||||||
|
{
|
||||||
|
Id = d.Id,
|
||||||
|
DisplayName = d.DisplayName,
|
||||||
|
CompletionCriteria = new EncounterCompletionCriteriaJson
|
||||||
|
{
|
||||||
|
Kind = d.CompletionCriteriaKind,
|
||||||
|
},
|
||||||
|
RequiredNpcInstanceIds = d.RequiredNpcInstanceIds,
|
||||||
|
RewardTable = MapRewardTable(rewardTable),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return Results.Json(
|
||||||
|
new EncounterDefinitionsListResponse
|
||||||
|
{
|
||||||
|
SchemaVersion = EncounterDefinitionsListResponse.CurrentSchemaVersion,
|
||||||
|
Encounters = encounters,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
return app;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static EncounterRewardTableJson MapRewardTable(RewardTableDefRow rewardTable)
|
||||||
|
{
|
||||||
|
var grants = new List<EncounterRewardGrantJson>(rewardTable.FixedGrants.Count);
|
||||||
|
foreach (var grant in rewardTable.FixedGrants)
|
||||||
|
{
|
||||||
|
grants.Add(
|
||||||
|
new EncounterRewardGrantJson
|
||||||
|
{
|
||||||
|
ItemId = grant.ItemId,
|
||||||
|
Quantity = grant.Quantity,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return new EncounterRewardTableJson
|
||||||
|
{
|
||||||
|
Id = rewardTable.Id,
|
||||||
|
DisplayName = rewardTable.DisplayName,
|
||||||
|
FixedGrants = grants,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -66,6 +66,7 @@ app.MapCombatTargetsWorldApi();
|
||||||
app.MapNpcRuntimeSnapshotWorldApi();
|
app.MapNpcRuntimeSnapshotWorldApi();
|
||||||
app.MapPlayerCombatHealthApi();
|
app.MapPlayerCombatHealthApi();
|
||||||
app.MapResourceNodeDefinitionsWorldApi();
|
app.MapResourceNodeDefinitionsWorldApi();
|
||||||
|
app.MapEncounterDefinitionsWorldApi();
|
||||||
app.MapPlayerInventoryApi();
|
app.MapPlayerInventoryApi();
|
||||||
app.MapPlayerCraftApi();
|
app.MapPlayerCraftApi();
|
||||||
app.MapSkillProgressionSnapshotApi();
|
app.MapSkillProgressionSnapshotApi();
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue