// Tests for the D&D 5e details the system keeps as a reference to an embedded item // (Syndria98/dragonroll#54). `system.details.background` and `system.details.race` are // LocalDocumentFields: they hold the id of the actor's background / race item and never // its name, and their `fallback` option hands the bare id back when that item is gone. // Dragonroll holds names, so reading the id as a name and writing it back gave Foundry a // background item that does not exist and a details reference resolving to nothing — // adding a background in Foundry then failed. // // The backend mapper is plain CommonJS and is required directly: it reads the // Foundry document and resolves those references to the names Dragonroll holds. // // Run with `npm test` from the repository root, or `node --test tests/`. const { test } = require("node:test"); const assert = require("node:assert/strict"); const path = require("node:path"); const { foundryActorToCharacter } = require(path.join(__dirname, "..", "backend", "src", "services", "actor-foundry.js")); // Foundry generates document ids as sixteen characters of its alphabet, digits included. const ID_GONE = "aB3cD9eF1gH2iJ4k"; const ID_SOLDIER = "Kx7pQ2mR9vT4wZ8n"; const ID_HUMAN = "7QcL2fYh5Bd0Mn3s"; function foundryActor(details = {}, items = []) { return { _id: "actor-1", name: "Thalia", type: "character", system: { details }, items }; } test("a background carried as an item arrives by its name, not its id", () => { const character = foundryActor( { background: ID_SOLDIER }, [{ _id: ID_SOLDIER, name: "Soldier", type: "background" }], ); assert.equal(foundryActorToCharacter(character).background, "Soldier"); }); test("a background reference whose item is gone does not become a background", () => { // The item was deleted, and `fallback: true` gives the id back instead. const character = foundryActor({ background: ID_GONE }, []); assert.equal(foundryActorToCharacter(character).background, ""); }); test("a background item takes the place of a reference that resolves to nothing", () => { const character = foundryActor( { background: ID_GONE }, [{ _id: ID_SOLDIER, name: "Soldier", type: "background" }], ); assert.equal(foundryActorToCharacter(character).background, "Soldier"); }); test("a plain-text background from an older system release is still a name", () => { const character = foundryActor({ background: "Sailor" }, []); assert.equal(foundryActorToCharacter(character).background, "Sailor"); }); test("the class, subclass and species references resolve the same way", () => { const items = [ { _id: ID_HUMAN, name: "Human", type: "race" }, { _id: "cls1Id00000000", name: "Fighter", type: "class" }, { _id: "sub1Id00000000", name: "Oracle", type: "subclass" }, ]; const character = foundryActor( { race: ID_HUMAN, class: "cls1Id00000000", subclass: "sub1Id00000000" }, items, ); const fields = foundryActorToCharacter(character); assert.equal(fields.species, "Human"); assert.equal(fields.className, "Fighter"); assert.equal(fields.subclass, "Oracle"); }); test("a class reference that resolves to nothing falls back to the class item", () => { const character = foundryActor( { class: ID_GONE, race: ID_GONE }, [{ _id: "cls1Id00000000", name: "Fighter", type: "class" }], ); const fields = foundryActorToCharacter(character); assert.equal(fields.className, "Fighter", "the class the actor carries, not the id"); assert.equal(fields.species, "", "and nothing to name the species from"); });