Enhance map layout and room definitions by adding optional labels for rooms and updating the API to support new room naming conventions. Introduce additional room types and localization strings for improved user experience in both English and Russian. Refactor map view logic to accommodate new room attributes and ensure accurate rendering in the UI. Update tests to validate changes in room structure and localization.
ci / server (push) Failing after 3m35s
ci / client (push) Successful in 13s

This commit is contained in:
Leonid Pershin
2026-08-18 16:47:37 +03:00
parent 7658443cd5
commit 6ca9ff9d03
18 changed files with 379 additions and 18 deletions
+1
View File
@@ -94,6 +94,7 @@ export interface MapLayout {
def: string; def: string;
building: string; building: string;
floor: string; floor: string;
label?: string;
slots?: { key: string; thing: string }[]; slots?: { key: string; thing: string }[];
}[]; }[];
links: { a: string; b: string }[]; links: { a: string; b: string }[];
+13 -2
View File
@@ -65,7 +65,7 @@ export function mapEditor(options: MapEditorOptions): {
for (const floor of map.floors.filter((candidate) => candidate.building === building.id)) { for (const floor of map.floors.filter((candidate) => candidate.building === building.id)) {
appendNode(tree, floor.id, floorName(catalog, floor), 2); appendNode(tree, floor.id, floorName(catalog, floor), 2);
for (const room of map.rooms.filter((candidate) => candidate.floor === floor.id)) { for (const room of map.rooms.filter((candidate) => candidate.floor === floor.id)) {
appendNode(tree, room.id, defLabel(catalog.rooms, room.def) ?? room.id, 3); appendNode(tree, room.id, roomName(catalog, room), 3);
} }
} }
} }
@@ -325,6 +325,17 @@ function floorName(catalog: CatalogResponse, floor: MapLayout['floors'][number])
return label.length > 0 ? `${def} ${label}` : def; return label.length > 0 ? `${def} ${label}` : def;
} }
function roomName(catalog: CatalogResponse, room: MapLayout['rooms'][number]): string {
const def = defLabel(catalog.rooms, room.def);
const label = room.label ?? '';
if (def === undefined) {
return label.length > 0 ? label : room.id;
}
return label.length > 0 ? `${def} ${label}` : def;
}
function defLabel(defs: readonly { defName: string; label: string }[], defName: string): string | undefined { function defLabel(defs: readonly { defName: string; label: string }[], defName: string): string | undefined {
return defs.find((def) => def.defName === defName)?.label; return defs.find((def) => def.defName === defName)?.label;
} }
@@ -346,7 +357,7 @@ function labelOf(catalog: CatalogResponse, map: MapLayout, id: string): string {
const room = map.rooms.find((node) => node.id === id); const room = map.rooms.find((node) => node.id === id);
if (room !== undefined) { if (room !== undefined) {
return defLabel(catalog.rooms, room.def) ?? id; return roomName(catalog, room);
} }
return id; return id;
+3
View File
@@ -52,6 +52,9 @@ public sealed class RoomNode
public required string Floor { get; init; } public required string Floor { get; init; }
/// <summary>Optional designation such as a classroom number. The def label still supplies the noun.</summary>
public string? Label { get; init; }
public IReadOnlyList<SlotFill> Slots { get; init; } = []; public IReadOnlyList<SlotFill> Slots { get; init; } = [];
} }
+10 -5
View File
@@ -84,7 +84,7 @@ public static class MapView
MapNodeKind.Room, MapNodeKind.Room,
room.Id, room.Id,
room.Floor, room.Floor,
LabelOf(catalog, locale, DefKind.Room, room.Def), RoomName(catalog, locale, room),
items, items,
PositionsOf(catalog, locale, DefKind.Room, room.Def))); PositionsOf(catalog, locale, DefKind.Room, room.Def)));
} }
@@ -117,12 +117,17 @@ public static class MapView
private static string FloorName(DefCatalog catalog, string locale, FloorNode floor) private static string FloorName(DefCatalog catalog, string locale, FloorNode floor)
{ {
var defLabel = LabelOf(catalog, locale, DefKind.Floor, floor.Def); var defLabel = LabelOf(catalog, locale, DefKind.Floor, floor.Def);
if (string.IsNullOrWhiteSpace(floor.Label)) return string.IsNullOrWhiteSpace(floor.Label) ? defLabel : $"{defLabel} {floor.Label}";
{
return defLabel;
} }
return defLabel == floor.Def ? floor.Label : $"{defLabel} {floor.Label}"; /// <summary>
/// Same rule as floors: <see cref="RoomNode.Label"/> is "1A", not a replacement for "Classroom".
/// Do not treat "label equals defName" as "untranslated" — English classrooms are named Classroom.
/// </summary>
private static string RoomName(DefCatalog catalog, string locale, RoomNode room)
{
var defLabel = LabelOf(catalog, locale, DefKind.Room, room.Def);
return string.IsNullOrWhiteSpace(room.Label) ? defLabel : $"{defLabel} {room.Label}";
} }
private static string LabelOf(DefCatalog catalog, string locale, DefKind kind, string defName) => private static string LabelOf(DefCatalog catalog, string locale, DefKind kind, string defName) =>
@@ -0,0 +1 @@
{ "defName": "GymBuilding" }
@@ -1 +0,0 @@
{ "defName": "Principal" }
@@ -0,0 +1,9 @@
[
{ "defName": "Principal" },
{ "defName": "Secretary" },
{ "defName": "Teacher" },
{ "defName": "Librarian" },
{ "defName": "Nurse" },
{ "defName": "PETeacher" },
{ "defName": "CafeteriaCook" },
]
@@ -0,0 +1,30 @@
[
{
"defName": "Classroom",
"slots": [
{ "key": "board", "thing": "Blackboard" },
{ "key": "teacherDesk", "thing": "Desk" },
{ "key": "studentDesks", "thing": "StudentDesk", "count": 16 },
],
"positions": ["Teacher"],
"works": ["TeachLesson"],
},
{
"defName": "Library",
"slots": [
{ "key": "desk", "thing": "Desk" },
{ "key": "shelves", "thing": "Bookshelf", "count": 4 },
],
"positions": ["Librarian"],
"works": ["LibraryWork"],
},
{
"defName": "ComputerLab",
"slots": [
{ "key": "teacherDesk", "thing": "Desk" },
{ "key": "computers", "thing": "Computer", "count": 12 },
],
"positions": ["Teacher"],
"works": ["TeachLesson"],
},
]
@@ -0,0 +1,5 @@
[
// Walkable rooms that exist to connect the graph: lobby, stairs. Empty on purpose.
{ "defName": "EntranceHall" },
{ "defName": "Stairwell" },
]
@@ -0,0 +1,8 @@
{
"defName": "GymHall",
"slots": [
{ "key": "benches", "thing": "Bench", "count": 4 },
],
"positions": ["PETeacher"],
"works": ["PELesson"],
}
@@ -0,0 +1,45 @@
[
{
"defName": "SecretaryOffice",
"slots": [
{ "key": "desk", "thing": "Desk" },
{ "key": "chair", "thing": "Chair" },
],
"positions": ["Secretary"],
"works": ["OfficeWork"],
},
{
"defName": "TeachersRoom",
"slots": [
{ "key": "table", "thing": "DiningTable" },
{ "key": "chairs", "thing": "Chair", "count": 6 },
],
},
{
"defName": "Cafeteria",
"slots": [
{ "key": "counter", "thing": "DiningTable" },
{ "key": "seats", "thing": "Chair", "count": 8 },
],
"positions": ["CafeteriaCook"],
"works": ["ServeLunch"],
},
{
"defName": "Restroom",
},
{
"defName": "MedicalOffice",
"slots": [
{ "key": "couch", "thing": "MedicalCouch" },
{ "key": "desk", "thing": "Desk" },
],
"positions": ["Nurse"],
"works": ["MedicalDuty"],
},
{
"defName": "ChangingRoom",
"slots": [
{ "key": "lockers", "thing": "Locker", "count": 12 },
],
},
]
@@ -0,0 +1,10 @@
[
{ "defName": "Blackboard" },
{ "defName": "StudentDesk", "parent": "Desk", "actions": ["Sit"] },
{ "defName": "Bookshelf" },
{ "defName": "DiningTable" },
{ "defName": "Bench", "actions": ["Sit"] },
{ "defName": "Computer" },
{ "defName": "MedicalCouch" },
{ "defName": "Locker" },
]
@@ -2,4 +2,9 @@
{ "defName": "PrincipalOfficeWork" }, { "defName": "PrincipalOfficeWork" },
{ "defName": "TeachLesson" }, { "defName": "TeachLesson" },
{ "defName": "WalkSchool" }, { "defName": "WalkSchool" },
{ "defName": "OfficeWork" },
{ "defName": "LibraryWork" },
{ "defName": "MedicalDuty" },
{ "defName": "PELesson" },
{ "defName": "ServeLunch" },
] ]
@@ -3,13 +3,45 @@
"Chair": "Chair", "Chair": "Chair",
"DirectorsChair": "Principal's chair", "DirectorsChair": "Principal's chair",
"Desk": "Desk", "Desk": "Desk",
"StudentDesk": "Student desk",
"Blackboard": "Blackboard",
"Bookshelf": "Bookshelf",
"DiningTable": "Table",
"Bench": "Bench",
"Computer": "Computer",
"MedicalCouch": "Exam couch",
"Locker": "Locker",
"Principal": "Principal", "Principal": "Principal",
"Secretary": "Secretary",
"Teacher": "Teacher",
"Librarian": "Librarian",
"Nurse": "Nurse",
"PETeacher": "PE teacher",
"CafeteriaCook": "Cook",
"PrincipalOfficeWork": "Principal's work", "PrincipalOfficeWork": "Principal's work",
"TeachLesson": "Teach a lesson", "TeachLesson": "Teach a lesson",
"WalkSchool": "Walk the school", "WalkSchool": "Walk the school",
"OfficeWork": "Office work",
"LibraryWork": "Library work",
"MedicalDuty": "Nurse's duty",
"PELesson": "PE lesson",
"ServeLunch": "Serve lunch",
"SchoolYard": "Yard", "SchoolYard": "Yard",
"MainBuilding": "Main building", "MainBuilding": "Main building",
"GymBuilding": "Gym building",
"StandardFloor": "Floor", "StandardFloor": "Floor",
"Corridor": "Corridor", "Corridor": "Corridor",
"EntranceHall": "Lobby",
"Stairwell": "Stairs",
"PrincipalsOffice": "Principal's office", "PrincipalsOffice": "Principal's office",
"SecretaryOffice": "Reception",
"TeachersRoom": "Staff room",
"Classroom": "Classroom",
"Cafeteria": "Cafeteria",
"Restroom": "Restroom",
"MedicalOffice": "Nurse's office",
"Library": "Library",
"ComputerLab": "Computer lab",
"GymHall": "Gym",
"ChangingRoom": "Changing room",
} }
@@ -3,13 +3,45 @@
"Chair": "Стул", "Chair": "Стул",
"DirectorsChair": "Кресло директора", "DirectorsChair": "Кресло директора",
"Desk": "Стол", "Desk": "Стол",
"StudentDesk": "Парта",
"Blackboard": "Доска",
"Bookshelf": "Стеллаж",
"DiningTable": "Обеденный стол",
"Bench": "Скамейка",
"Computer": "Компьютер",
"MedicalCouch": "Кушетка",
"Locker": "Шкафчик",
"Principal": "Директор", "Principal": "Директор",
"Secretary": "Секретарь",
"Teacher": "Учитель",
"Librarian": "Библиотекарь",
"Nurse": "Медсестра",
"PETeacher": "Учитель физкультуры",
"CafeteriaCook": "Повар",
"PrincipalOfficeWork": "Работа директора", "PrincipalOfficeWork": "Работа директора",
"TeachLesson": "Урок", "TeachLesson": "Урок",
"WalkSchool": "Обход школы", "WalkSchool": "Обход школы",
"OfficeWork": "Канцелярия",
"LibraryWork": "Работа в библиотеке",
"MedicalDuty": "Медпункт",
"PELesson": "Урок физкультуры",
"ServeLunch": "Раздача обеда",
"SchoolYard": "Двор", "SchoolYard": "Двор",
"MainBuilding": "Главный корпус", "MainBuilding": "Главный корпус",
"GymBuilding": "Спортзал",
"StandardFloor": "Этаж", "StandardFloor": "Этаж",
"Corridor": "Коридор", "Corridor": "Коридор",
"EntranceHall": "Вестибюль",
"Stairwell": "Лестница",
"PrincipalsOffice": "Кабинет директора", "PrincipalsOffice": "Кабинет директора",
"SecretaryOffice": "Приёмная",
"TeachersRoom": "Учительская",
"Classroom": "Класс",
"Cafeteria": "Столовая",
"Restroom": "Туалет",
"MedicalOffice": "Медкабинет",
"Library": "Библиотека",
"ComputerLab": "Компьютерный класс",
"GymHall": "Спортивный зал",
"ChangingRoom": "Раздевалка",
} }
+157 -8
View File
@@ -1,19 +1,20 @@
{ {
// Walkable yard is the tree root and a graph node. Rooms reach it through the porch/corridor. // A small two-storey school: main building on the yard, gym across the yard.
// Walkable graph is yard + rooms; floors are grouping only. Stairs link the two corridors.
"territory": { "id": "yard", "def": "SchoolYard" }, "territory": { "id": "yard", "def": "SchoolYard" },
"buildings": [ "buildings": [
{ "id": "main", "def": "MainBuilding" }, { "id": "main", "def": "MainBuilding" },
{ "id": "gym", "def": "GymBuilding" },
], ],
"floors": [ "floors": [
{ "id": "floor-1", "def": "StandardFloor", "building": "main", "label": "1" }, { "id": "floor-1", "def": "StandardFloor", "building": "main", "label": "1" },
{ "id": "floor-2", "def": "StandardFloor", "building": "main", "label": "2" },
{ "id": "gym-floor", "def": "StandardFloor", "building": "gym" },
], ],
"rooms": [ "rooms": [
{ { "id": "porch", "def": "EntranceHall", "building": "main", "floor": "floor-1" },
"id": "corridor-1", { "id": "corridor-1", "def": "Corridor", "building": "main", "floor": "floor-1", "label": "1" },
"def": "Corridor", { "id": "stairs-1", "def": "Stairwell", "building": "main", "floor": "floor-1", "label": "1" },
"building": "main",
"floor": "floor-1",
},
{ {
"id": "principals-office", "id": "principals-office",
"def": "PrincipalsOffice", "def": "PrincipalsOffice",
@@ -25,9 +26,157 @@
{ "key": "guestChair", "thing": "Chair" }, { "key": "guestChair", "thing": "Chair" },
], ],
}, },
{
"id": "secretary-office",
"def": "SecretaryOffice",
"building": "main",
"floor": "floor-1",
"slots": [
{ "key": "desk", "thing": "Desk" },
{ "key": "chair", "thing": "Chair" },
],
},
{
"id": "teachers-room",
"def": "TeachersRoom",
"building": "main",
"floor": "floor-1",
"slots": [
{ "key": "table", "thing": "DiningTable" },
{ "key": "chairs", "thing": "Chair" },
],
},
{
"id": "classroom-1a",
"def": "Classroom",
"building": "main",
"floor": "floor-1",
"label": "1A",
"slots": [
{ "key": "board", "thing": "Blackboard" },
{ "key": "teacherDesk", "thing": "Desk" },
{ "key": "studentDesks", "thing": "StudentDesk" },
],
},
{
"id": "classroom-1b",
"def": "Classroom",
"building": "main",
"floor": "floor-1",
"label": "1B",
"slots": [
{ "key": "board", "thing": "Blackboard" },
{ "key": "teacherDesk", "thing": "Desk" },
{ "key": "studentDesks", "thing": "StudentDesk" },
],
},
{
"id": "cafeteria",
"def": "Cafeteria",
"building": "main",
"floor": "floor-1",
"slots": [
{ "key": "counter", "thing": "DiningTable" },
{ "key": "seats", "thing": "Chair" },
],
},
{ "id": "restroom-1", "def": "Restroom", "building": "main", "floor": "floor-1", "label": "1" },
{
"id": "medical-office",
"def": "MedicalOffice",
"building": "main",
"floor": "floor-1",
"slots": [
{ "key": "couch", "thing": "MedicalCouch" },
{ "key": "desk", "thing": "Desk" },
],
},
{ "id": "corridor-2", "def": "Corridor", "building": "main", "floor": "floor-2", "label": "2" },
{ "id": "stairs-2", "def": "Stairwell", "building": "main", "floor": "floor-2", "label": "2" },
{
"id": "classroom-2a",
"def": "Classroom",
"building": "main",
"floor": "floor-2",
"label": "2A",
"slots": [
{ "key": "board", "thing": "Blackboard" },
{ "key": "teacherDesk", "thing": "Desk" },
{ "key": "studentDesks", "thing": "StudentDesk" },
],
},
{
"id": "classroom-2b",
"def": "Classroom",
"building": "main",
"floor": "floor-2",
"label": "2B",
"slots": [
{ "key": "board", "thing": "Blackboard" },
{ "key": "teacherDesk", "thing": "Desk" },
{ "key": "studentDesks", "thing": "StudentDesk" },
],
},
{
"id": "library",
"def": "Library",
"building": "main",
"floor": "floor-2",
"slots": [
{ "key": "desk", "thing": "Desk" },
{ "key": "shelves", "thing": "Bookshelf" },
],
},
{
"id": "computer-lab",
"def": "ComputerLab",
"building": "main",
"floor": "floor-2",
"slots": [
{ "key": "teacherDesk", "thing": "Desk" },
{ "key": "computers", "thing": "Computer" },
],
},
{ "id": "restroom-2", "def": "Restroom", "building": "main", "floor": "floor-2", "label": "2" },
{
"id": "gym-hall",
"def": "GymHall",
"building": "gym",
"floor": "gym-floor",
"slots": [
{ "key": "benches", "thing": "Bench" },
],
},
{
"id": "changing-room",
"def": "ChangingRoom",
"building": "gym",
"floor": "gym-floor",
"slots": [
{ "key": "lockers", "thing": "Locker" },
],
},
], ],
"links": [ "links": [
{ "a": "yard", "b": "corridor-1" }, { "a": "yard", "b": "porch" },
{ "a": "porch", "b": "corridor-1" },
{ "a": "corridor-1", "b": "stairs-1" },
{ "a": "corridor-1", "b": "principals-office" }, { "a": "corridor-1", "b": "principals-office" },
{ "a": "corridor-1", "b": "secretary-office" },
{ "a": "corridor-1", "b": "teachers-room" },
{ "a": "corridor-1", "b": "classroom-1a" },
{ "a": "corridor-1", "b": "classroom-1b" },
{ "a": "corridor-1", "b": "cafeteria" },
{ "a": "corridor-1", "b": "restroom-1" },
{ "a": "corridor-1", "b": "medical-office" },
{ "a": "stairs-1", "b": "stairs-2" },
{ "a": "stairs-2", "b": "corridor-2" },
{ "a": "corridor-2", "b": "classroom-2a" },
{ "a": "corridor-2", "b": "classroom-2b" },
{ "a": "corridor-2", "b": "library" },
{ "a": "corridor-2", "b": "computer-lab" },
{ "a": "corridor-2", "b": "restroom-2" },
{ "a": "yard", "b": "gym-hall" },
{ "a": "gym-hall", "b": "changing-room" },
], ],
} }
+10 -1
View File
@@ -14,10 +14,12 @@ public class MapViewTests
var ru = MapView.Build(catalog, map, "ru"); var ru = MapView.Build(catalog, map, "ru");
var en = MapView.Build(catalog, map, "en"); var en = MapView.Build(catalog, map, "en");
Assert.Equal(["yard", "main", "floor-1", "corridor-1", "principals-office"], ru.Select(node => node.Id)); Assert.Equal("yard", ru[0].Id);
Assert.Equal(string.Empty, ru[0].ParentId); Assert.Equal(string.Empty, ru[0].ParentId);
Assert.Equal("yard", ru.Single(node => node.Id == "main").ParentId); Assert.Equal("yard", ru.Single(node => node.Id == "main").ParentId);
Assert.Equal("yard", ru.Single(node => node.Id == "gym").ParentId);
Assert.Equal("floor-1", ru.Single(node => node.Id == "principals-office").ParentId); Assert.Equal("floor-1", ru.Single(node => node.Id == "principals-office").ParentId);
Assert.Equal("gym-floor", ru.Single(node => node.Id == "gym-hall").ParentId);
var officeRu = ru.Single(node => node.Id == "principals-office"); var officeRu = ru.Single(node => node.Id == "principals-office");
Assert.Equal("Кабинет директора", officeRu.Name); Assert.Equal("Кабинет директора", officeRu.Name);
@@ -32,6 +34,13 @@ public class MapViewTests
var corridor = ru.Single(node => node.Id == "corridor-1"); var corridor = ru.Single(node => node.Id == "corridor-1");
Assert.Empty(corridor.Items); Assert.Empty(corridor.Items);
Assert.Empty(corridor.Positions); Assert.Empty(corridor.Positions);
Assert.Equal("Коридор 1", corridor.Name);
var classroom = ru.Single(node => node.Id == "classroom-1a");
Assert.Equal("Класс 1A", classroom.Name);
Assert.Equal(["Доска", "Стол", "Парта"], classroom.Items);
Assert.Equal(["Учитель"], classroom.Positions);
Assert.Equal("Classroom 1A", en.Single(node => node.Id == "classroom-1a").Name);
} }
[Fact] [Fact]
@@ -21,5 +21,12 @@ public class VanillaCoreTests
Assert.Equal("Кабинет директора", catalog.Label("ru", catalog.Rooms["PrincipalsOffice"])); Assert.Equal("Кабинет директора", catalog.Label("ru", catalog.Rooms["PrincipalsOffice"]));
Assert.Equal("Principal's office", catalog.Label("en", catalog.Rooms["PrincipalsOffice"])); Assert.Equal("Principal's office", catalog.Label("en", catalog.Rooms["PrincipalsOffice"]));
Assert.Equal(["Sit"], catalog.Things["DirectorsChair"].Actions); Assert.Equal(["Sit"], catalog.Things["DirectorsChair"].Actions);
Assert.True(catalog.Buildings.ContainsKey("GymBuilding"));
Assert.True(catalog.Rooms.ContainsKey("Classroom"));
Assert.Equal("Класс", catalog.Label("ru", catalog.Rooms["Classroom"]));
Assert.Equal(["Teacher"], catalog.PositionsFor(DefKind.Room, "Classroom"));
Assert.Equal(2, map.Buildings.Count);
Assert.True(map.Rooms.Count >= 18, "Vanilla layout should look like a small school, not a stub.");
Assert.Contains(map.Rooms, room => room.Id == "classroom-1a" && room.Label == "1A");
} }
} }