Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a44f82127e | ||
|
|
c3707cf0b6 | ||
|
|
1eaeecad32 | ||
|
|
e2e8297c95 | ||
|
|
e161645228 | ||
|
|
9b0cb38897 |
@@ -116,6 +116,7 @@ export function createTestAdapters(options?: {
|
||||
`https://example.com/creatures-${sourceCode.toLowerCase()}.json`,
|
||||
getSourceDisplayName: (sourceCode) => sourceCode,
|
||||
getCreaturePathsForSource: () => [],
|
||||
getCreatureNamesByPaths: () => new Map(),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
@@ -33,8 +33,7 @@ async function addCombatant(
|
||||
opts?: { maxHp?: string },
|
||||
) {
|
||||
const inputs = screen.getAllByPlaceholderText("+ Add combatants");
|
||||
// biome-ignore lint/style/noNonNullAssertion: getAllBy always returns at least one
|
||||
const input = inputs.at(-1)!;
|
||||
const input = inputs.at(-1) ?? inputs[0];
|
||||
await user.type(input, name);
|
||||
|
||||
if (opts?.maxHp) {
|
||||
|
||||
@@ -198,21 +198,23 @@ describe("ConfirmButton", () => {
|
||||
|
||||
it("Enter/Space keydown stops propagation to prevent parent handlers", () => {
|
||||
const parentHandler = vi.fn();
|
||||
render(
|
||||
// biome-ignore lint/a11y/noStaticElementInteractions: test wrapper
|
||||
// biome-ignore lint/a11y/noNoninteractiveElementInteractions: test wrapper
|
||||
<div onKeyDown={parentHandler}>
|
||||
function Wrapper() {
|
||||
return (
|
||||
<button type="button" onKeyDown={parentHandler}>
|
||||
<ConfirmButton
|
||||
icon={<XIcon />}
|
||||
label="Remove combatant"
|
||||
onConfirm={vi.fn()}
|
||||
/>
|
||||
</div>,
|
||||
</button>
|
||||
);
|
||||
const button = screen.getByRole("button");
|
||||
}
|
||||
render(<Wrapper />);
|
||||
const buttons = screen.getAllByRole("button");
|
||||
const confirmButton = buttons.at(-1) ?? buttons[0];
|
||||
|
||||
fireEvent.keyDown(button, { key: "Enter" });
|
||||
fireEvent.keyDown(button, { key: " " });
|
||||
fireEvent.keyDown(confirmButton, { key: "Enter" });
|
||||
fireEvent.keyDown(confirmButton, { key: " " });
|
||||
|
||||
expect(parentHandler).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
@@ -181,17 +181,20 @@ describe("normalizeBestiary", () => {
|
||||
expect(sc?.name).toBe("Spellcasting");
|
||||
expect(sc?.headerText).toContain("DC 15");
|
||||
expect(sc?.headerText).not.toContain("{@");
|
||||
expect(sc?.atWill).toEqual(["Detect Magic", "Mage Hand"]);
|
||||
expect(sc?.atWill).toEqual([
|
||||
{ name: "Detect Magic" },
|
||||
{ name: "Mage Hand" },
|
||||
]);
|
||||
expect(sc?.daily).toHaveLength(2);
|
||||
expect(sc?.daily).toContainEqual({
|
||||
uses: 2,
|
||||
each: true,
|
||||
spells: ["Fireball"],
|
||||
spells: [{ name: "Fireball" }],
|
||||
});
|
||||
expect(sc?.daily).toContainEqual({
|
||||
uses: 1,
|
||||
each: false,
|
||||
spells: ["Dimension Door"],
|
||||
spells: [{ name: "Dimension Door" }],
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
@@ -131,6 +131,39 @@ describe("normalizeFoundryCreature", () => {
|
||||
);
|
||||
expect(creature.senses).toBe("Scent 60 feet");
|
||||
});
|
||||
|
||||
it("extracts perception details", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
system: {
|
||||
...minimalCreature().system,
|
||||
perception: {
|
||||
mod: 35,
|
||||
details: "smoke vision",
|
||||
senses: [{ type: "darkvision" }],
|
||||
},
|
||||
},
|
||||
}),
|
||||
);
|
||||
expect(creature.perceptionDetails).toBe("smoke vision");
|
||||
expect(creature.senses).toBe("Darkvision");
|
||||
});
|
||||
|
||||
it("omits perception details when empty", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
system: {
|
||||
...minimalCreature().system,
|
||||
perception: {
|
||||
mod: 8,
|
||||
details: "",
|
||||
senses: [{ type: "darkvision" }],
|
||||
},
|
||||
},
|
||||
}),
|
||||
);
|
||||
expect(creature.perceptionDetails).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("languages formatting", () => {
|
||||
@@ -386,6 +419,101 @@ describe("normalizeFoundryCreature", () => {
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it("includes attack effects in damage text", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "atk1",
|
||||
name: "talon",
|
||||
type: "melee",
|
||||
system: {
|
||||
bonus: { value: 14 },
|
||||
damageRolls: {
|
||||
abc: {
|
||||
damage: "1d10+6",
|
||||
damageType: "piercing",
|
||||
},
|
||||
},
|
||||
traits: { value: [] },
|
||||
attackEffects: { value: ["grab"] },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const attack = creature.attacks?.[0];
|
||||
expect(attack?.segments[0]).toEqual({
|
||||
type: "text",
|
||||
value: "+14, 1d10+6 piercing plus Grab",
|
||||
});
|
||||
});
|
||||
|
||||
it("joins multiple attack effects with 'and'", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "atk1",
|
||||
name: "claw",
|
||||
type: "melee",
|
||||
system: {
|
||||
bonus: { value: 18 },
|
||||
damageRolls: {
|
||||
abc: {
|
||||
damage: "2d8+6",
|
||||
damageType: "slashing",
|
||||
},
|
||||
},
|
||||
traits: { value: [] },
|
||||
attackEffects: {
|
||||
value: ["grab", "knockdown"],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const attack = creature.attacks?.[0];
|
||||
expect(attack?.segments[0]).toEqual({
|
||||
type: "text",
|
||||
value: "+18, 2d8+6 slashing plus Grab and Knockdown",
|
||||
});
|
||||
});
|
||||
|
||||
it("strips creature-name prefix from attack effect slugs", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
name: "Lich",
|
||||
items: [
|
||||
{
|
||||
_id: "atk1",
|
||||
name: "hand",
|
||||
type: "melee",
|
||||
system: {
|
||||
bonus: { value: 24 },
|
||||
damageRolls: {
|
||||
abc: {
|
||||
damage: "2d12+7",
|
||||
damageType: "negative",
|
||||
},
|
||||
},
|
||||
traits: { value: [] },
|
||||
attackEffects: {
|
||||
value: ["lich-siphon-life"],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const attack = creature.attacks?.[0];
|
||||
expect(attack?.segments[0]).toEqual({
|
||||
type: "text",
|
||||
value: "+24, 2d12+7 negative plus Siphon Life",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("ability normalization", () => {
|
||||
@@ -539,6 +667,396 @@ describe("normalizeFoundryCreature", () => {
|
||||
: undefined,
|
||||
).toBe("(Concentrate, Polymorph) Takes a new form.");
|
||||
});
|
||||
|
||||
it("extracts frequency from ability", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "a1",
|
||||
name: "Drain Soul Cage",
|
||||
type: "action",
|
||||
system: {
|
||||
category: "offensive",
|
||||
actionType: { value: "free" },
|
||||
actions: { value: null },
|
||||
traits: { value: [] },
|
||||
description: { value: "<p>Drains the soul.</p>" },
|
||||
frequency: { max: 1, per: "day" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.abilitiesBot?.[0]?.frequency).toBe("1/day");
|
||||
});
|
||||
|
||||
it("strips redundant frequency line from description", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "a1",
|
||||
name: "Consult the Text",
|
||||
type: "action",
|
||||
system: {
|
||||
category: "offensive",
|
||||
actionType: { value: "action" },
|
||||
actions: { value: 1 },
|
||||
traits: { value: [] },
|
||||
description: {
|
||||
value:
|
||||
"<p><strong>Frequency</strong> once per day</p>\n<hr />\n<p><strong>Effect</strong> The lich opens their spell tome.</p>",
|
||||
},
|
||||
frequency: { max: 1, per: "day" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const text =
|
||||
creature.abilitiesBot?.[0]?.segments[0]?.type === "text"
|
||||
? creature.abilitiesBot[0].segments[0].value
|
||||
: "";
|
||||
expect(text).not.toContain("Frequency");
|
||||
expect(text).toContain("The lich opens their spell tome.");
|
||||
});
|
||||
|
||||
it("strips frequency line even when preceded by other text", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "a1",
|
||||
name: "Drain Soul Cage",
|
||||
type: "action",
|
||||
system: {
|
||||
category: "offensive",
|
||||
actionType: { value: "free" },
|
||||
actions: { value: null },
|
||||
traits: { value: [] },
|
||||
description: {
|
||||
value:
|
||||
"<p>6th rank</p>\n<hr />\n<p><strong>Frequency</strong> once per day</p>\n<hr />\n<p><strong>Effect</strong> The lich taps into their soul cage.</p>",
|
||||
},
|
||||
frequency: { max: 1, per: "day" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const text =
|
||||
creature.abilitiesBot?.[0]?.segments[0]?.type === "text"
|
||||
? creature.abilitiesBot[0].segments[0].value
|
||||
: "";
|
||||
expect(text).not.toContain("Frequency");
|
||||
expect(text).toContain("6th rank");
|
||||
expect(text).toContain("The lich taps into their soul cage.");
|
||||
});
|
||||
|
||||
it("omits frequency when not present", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "a1",
|
||||
name: "Strike",
|
||||
type: "action",
|
||||
system: {
|
||||
category: "offensive",
|
||||
actionType: { value: "action" },
|
||||
actions: { value: 1 },
|
||||
traits: { value: [] },
|
||||
description: { value: "<p>Strikes.</p>" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.abilitiesBot?.[0]?.frequency).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("equipment normalization", () => {
|
||||
it("normalizes a weapon with traits and description", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "w1",
|
||||
name: "Flaming Longsword",
|
||||
type: "weapon",
|
||||
system: {
|
||||
level: { value: 5 },
|
||||
traits: { value: ["magical", "fire"] },
|
||||
description: {
|
||||
value: "<p>This sword blazes with fire.</p>",
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.equipment).toHaveLength(1);
|
||||
const item = creature.equipment?.[0];
|
||||
expect(item?.name).toBe("Flaming Longsword");
|
||||
expect(item?.level).toBe(5);
|
||||
expect(item?.traits).toEqual(["magical", "fire"]);
|
||||
expect(item?.description).toBe("This sword blazes with fire.");
|
||||
});
|
||||
|
||||
it("normalizes a consumable potion with description", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "c1",
|
||||
name: "Healing Potion (Moderate)",
|
||||
type: "consumable",
|
||||
system: {
|
||||
level: { value: 6 },
|
||||
traits: { value: ["consumable", "healing", "magical"] },
|
||||
description: {
|
||||
value: "<p>Restores 3d8+10 Hit Points.</p>",
|
||||
},
|
||||
category: "potion",
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.equipment).toHaveLength(1);
|
||||
const item = creature.equipment?.[0];
|
||||
expect(item?.name).toBe("Healing Potion (Moderate)");
|
||||
expect(item?.category).toBe("potion");
|
||||
expect(item?.description).toBe("Restores 3d8+10 Hit Points.");
|
||||
});
|
||||
|
||||
it("extracts scroll embedded spell name and rank", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "s1",
|
||||
name: "Scroll of Teleport (Rank 6)",
|
||||
type: "consumable",
|
||||
system: {
|
||||
level: { value: 11 },
|
||||
traits: { value: ["consumable", "magical", "scroll"] },
|
||||
description: { value: "<p>A scroll.</p>" },
|
||||
category: "scroll",
|
||||
spell: {
|
||||
name: "Teleport",
|
||||
system: { level: { value: 6 } },
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const item = creature.equipment?.[0];
|
||||
expect(item?.spellName).toBe("Teleport");
|
||||
expect(item?.spellRank).toBe(6);
|
||||
});
|
||||
|
||||
it("extracts wand embedded spell name and rank", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "w1",
|
||||
name: "Wand of Dispel Magic (Rank 2)",
|
||||
type: "consumable",
|
||||
system: {
|
||||
level: { value: 5 },
|
||||
traits: { value: ["consumable", "magical", "wand"] },
|
||||
description: { value: "<p>A wand.</p>" },
|
||||
category: "wand",
|
||||
spell: {
|
||||
name: "Dispel Magic",
|
||||
system: { level: { value: 2 } },
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const item = creature.equipment?.[0];
|
||||
expect(item?.spellName).toBe("Dispel Magic");
|
||||
expect(item?.spellRank).toBe(2);
|
||||
});
|
||||
|
||||
it("filters magical equipment into equipment field", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "e1",
|
||||
name: "Ring of Energy Resistance (Fire)",
|
||||
type: "equipment",
|
||||
system: {
|
||||
level: { value: 6 },
|
||||
traits: { value: ["magical", "invested"] },
|
||||
description: {
|
||||
value: "<p>Grants fire resistance 5.</p>",
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.equipment).toHaveLength(1);
|
||||
expect(creature.equipment?.[0]?.name).toBe(
|
||||
"Ring of Energy Resistance (Fire)",
|
||||
);
|
||||
expect(creature.items).toBeUndefined();
|
||||
});
|
||||
|
||||
it("filters mundane items into items string", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "w1",
|
||||
name: "Longsword",
|
||||
type: "weapon",
|
||||
system: {
|
||||
level: { value: 0 },
|
||||
traits: { value: [] },
|
||||
description: { value: "" },
|
||||
},
|
||||
},
|
||||
{
|
||||
_id: "a1",
|
||||
name: "Leather Armor",
|
||||
type: "armor",
|
||||
system: {
|
||||
level: { value: 0 },
|
||||
traits: { value: [] },
|
||||
description: { value: "" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.items).toBe("Longsword, Leather Armor");
|
||||
expect(creature.equipment).toBeUndefined();
|
||||
});
|
||||
|
||||
it("omits equipment when no detailed items exist", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "w1",
|
||||
name: "Dagger",
|
||||
type: "weapon",
|
||||
system: {
|
||||
level: { value: 0 },
|
||||
traits: { value: [] },
|
||||
description: { value: "" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.equipment).toBeUndefined();
|
||||
});
|
||||
|
||||
it("omits items when no mundane items exist", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "c1",
|
||||
name: "Giant Wasp Venom",
|
||||
type: "consumable",
|
||||
system: {
|
||||
level: { value: 7 },
|
||||
traits: { value: ["consumable", "poison"] },
|
||||
description: {
|
||||
value: "<p>A deadly poison.</p>",
|
||||
},
|
||||
category: "poison",
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.items).toBeUndefined();
|
||||
expect(creature.equipment).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("includes armor with special material in equipment", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "a1",
|
||||
name: "Adamantine Full Plate",
|
||||
type: "armor",
|
||||
system: {
|
||||
level: { value: 0 },
|
||||
traits: { value: [] },
|
||||
description: {
|
||||
value: "<p>Full plate made of adamantine.</p>",
|
||||
},
|
||||
material: { type: "adamantine", grade: "standard" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.equipment).toHaveLength(1);
|
||||
expect(creature.equipment?.[0]?.name).toBe("Adamantine Full Plate");
|
||||
});
|
||||
|
||||
it("excludes mundane armor from equipment (goes to items)", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "a1",
|
||||
name: "Chain Mail",
|
||||
type: "armor",
|
||||
system: {
|
||||
level: { value: 0 },
|
||||
traits: { value: [] },
|
||||
description: { value: "" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
expect(creature.equipment).toBeUndefined();
|
||||
expect(creature.items).toBe("Chain Mail");
|
||||
});
|
||||
|
||||
it("strips Foundry HTML tags from equipment descriptions", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "c1",
|
||||
name: "Potion of Speed",
|
||||
type: "consumable",
|
||||
system: {
|
||||
level: { value: 10 },
|
||||
traits: { value: ["consumable", "magical"] },
|
||||
description: {
|
||||
value:
|
||||
"<p>Gain @UUID[Compendium.pf2e.conditionitems.Item.Quickened]{quickened} for 1 minute.</p>",
|
||||
},
|
||||
category: "potion",
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const desc = creature.equipment?.[0]?.description;
|
||||
expect(desc).toBe("Gain quickened for 1 minute.");
|
||||
expect(desc).not.toContain("@UUID");
|
||||
});
|
||||
});
|
||||
|
||||
describe("spellcasting normalization", () => {
|
||||
@@ -593,11 +1111,12 @@ describe("normalizeFoundryCreature", () => {
|
||||
const sc = creature.spellcasting?.[0];
|
||||
expect(sc?.name).toBe("Primal Prepared Spells");
|
||||
expect(sc?.headerText).toBe("DC 30, attack +22");
|
||||
expect(sc?.daily).toEqual([
|
||||
{ uses: 6, each: true, spells: ["Earthquake"] },
|
||||
{ uses: 3, each: true, spells: ["Heal"] },
|
||||
]);
|
||||
expect(sc?.atWill).toEqual(["Detect Magic"]);
|
||||
expect(sc?.daily?.map((d) => d.uses)).toEqual([6, 3]);
|
||||
expect(sc?.daily?.[0]?.spells.map((s) => s.name)).toEqual(["Earthquake"]);
|
||||
expect(sc?.daily?.[1]?.spells.map((s) => s.name)).toEqual(["Heal"]);
|
||||
expect(sc?.atWill?.map((s) => s.name)).toEqual(["Detect Magic"]);
|
||||
// Cantrip rank auto-heightens to ceil(creatureLevel / 2) = ceil(3/2) = 2
|
||||
expect(sc?.atWill?.[0]?.rank).toBe(2);
|
||||
});
|
||||
|
||||
it("normalizes innate spells with uses", () => {
|
||||
@@ -633,13 +1152,334 @@ describe("normalizeFoundryCreature", () => {
|
||||
);
|
||||
const sc = creature.spellcasting?.[0];
|
||||
expect(sc?.headerText).toBe("DC 32");
|
||||
expect(sc?.daily).toEqual([
|
||||
expect(sc?.daily).toHaveLength(1);
|
||||
const spell = sc?.daily?.[0]?.spells[0];
|
||||
expect(spell?.name).toBe("Sure Strike");
|
||||
expect(spell?.usesPerDay).toBe(3);
|
||||
expect(spell?.rank).toBe(1);
|
||||
});
|
||||
|
||||
it("preserves full spell data including description and heightening", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
uses: 1,
|
||||
each: true,
|
||||
spells: ["Sure Strike (\u00d73)"],
|
||||
_id: "entry1",
|
||||
name: "Divine Innate Spells",
|
||||
type: "spellcastingEntry",
|
||||
system: {
|
||||
tradition: { value: "divine" },
|
||||
prepared: { value: "innate" },
|
||||
spelldc: { dc: 35, value: 27 },
|
||||
},
|
||||
]);
|
||||
},
|
||||
{
|
||||
_id: "s1",
|
||||
name: "Heal",
|
||||
type: "spell",
|
||||
system: {
|
||||
slug: "heal",
|
||||
location: { value: "entry1" },
|
||||
level: { value: 6 },
|
||||
traits: {
|
||||
rarity: "common",
|
||||
value: ["healing", "vitality"],
|
||||
traditions: ["divine", "primal"],
|
||||
},
|
||||
description: {
|
||||
value:
|
||||
"<p>You channel @UUID[Compendium.pf2e.spells.Item.Heal]{positive} energy to heal the living. The target regains @Damage[2d8[vitality]] Hit Points.</p>",
|
||||
},
|
||||
range: { value: "30 feet" },
|
||||
target: { value: "1 willing creature" },
|
||||
duration: { value: "" },
|
||||
defense: undefined,
|
||||
time: { value: "1" },
|
||||
heightening: {
|
||||
type: "interval",
|
||||
interval: 1,
|
||||
damage: { value: "2d8" },
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
_id: "s2",
|
||||
name: "Force Barrage",
|
||||
type: "spell",
|
||||
system: {
|
||||
location: { value: "entry1" },
|
||||
level: { value: 1 },
|
||||
traits: { value: ["concentrate", "manipulate"] },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const sc = creature.spellcasting?.[0];
|
||||
expect(sc).toBeDefined();
|
||||
const heal = sc?.daily
|
||||
?.flatMap((d) => d.spells)
|
||||
.find((s) => s.name === "Heal");
|
||||
expect(heal).toBeDefined();
|
||||
expect(heal?.slug).toBe("heal");
|
||||
expect(heal?.rank).toBe(6);
|
||||
expect(heal?.range).toBe("30 feet");
|
||||
expect(heal?.target).toBe("1 willing creature");
|
||||
expect(heal?.traits).toEqual(["healing", "vitality"]);
|
||||
expect(heal?.traditions).toEqual(["divine", "primal"]);
|
||||
expect(heal?.actionCost).toBe("1");
|
||||
// Foundry tags stripped from description
|
||||
expect(heal?.description).toContain("positive");
|
||||
expect(heal?.description).not.toContain("@UUID");
|
||||
expect(heal?.description).not.toContain("@Damage");
|
||||
// Interval heightening formatted and not duplicated in description
|
||||
expect(heal?.heightening).toBe("Heightened (+1) damage increases by 2d8");
|
||||
|
||||
// Spell without optional data still has name + rank
|
||||
const fb = sc?.daily
|
||||
?.flatMap((d) => d.spells)
|
||||
.find((s) => s.name === "Force Barrage");
|
||||
expect(fb).toBeDefined();
|
||||
expect(fb?.rank).toBe(1);
|
||||
expect(fb?.description).toBeUndefined();
|
||||
expect(fb?.usesPerDay).toBeUndefined();
|
||||
});
|
||||
|
||||
it("formats fixed-type heightening levels", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "entry1",
|
||||
name: "Divine Prepared Spells",
|
||||
type: "spellcastingEntry",
|
||||
system: {
|
||||
tradition: { value: "divine" },
|
||||
prepared: { value: "prepared" },
|
||||
spelldc: { dc: 30 },
|
||||
},
|
||||
},
|
||||
{
|
||||
_id: "s1",
|
||||
name: "Magic Missile",
|
||||
type: "spell",
|
||||
system: {
|
||||
location: { value: "entry1" },
|
||||
level: { value: 1 },
|
||||
traits: { value: [] },
|
||||
heightening: {
|
||||
type: "fixed",
|
||||
levels: {
|
||||
"3": { text: "<p>You shoot two more missiles.</p>" },
|
||||
"5": { text: "<p>You shoot four more missiles.</p>" },
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const spell = creature.spellcasting?.[0]?.daily
|
||||
?.flatMap((d) => d.spells)
|
||||
.find((s) => s.name === "Magic Missile");
|
||||
expect(spell?.heightening).toContain(
|
||||
"Heightened (3) You shoot two more missiles.",
|
||||
);
|
||||
expect(spell?.heightening).toContain(
|
||||
"Heightened (5) You shoot four more missiles.",
|
||||
);
|
||||
});
|
||||
|
||||
it("formats save defense", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "entry1",
|
||||
name: "Arcane Innate Spells",
|
||||
type: "spellcastingEntry",
|
||||
system: {
|
||||
tradition: { value: "arcane" },
|
||||
prepared: { value: "innate" },
|
||||
spelldc: { dc: 25 },
|
||||
},
|
||||
},
|
||||
{
|
||||
_id: "s1",
|
||||
name: "Fireball",
|
||||
type: "spell",
|
||||
system: {
|
||||
location: { value: "entry1" },
|
||||
level: { value: 3 },
|
||||
traits: { value: ["fire"] },
|
||||
area: { type: "burst", value: 20 },
|
||||
defense: {
|
||||
save: { statistic: "reflex", basic: true },
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const fireball = creature.spellcasting?.[0]?.daily
|
||||
?.flatMap((d) => d.spells)
|
||||
.find((s) => s.name === "Fireball");
|
||||
expect(fireball?.defense).toBe("basic Reflex");
|
||||
expect(fireball?.area).toBe("20-foot burst");
|
||||
});
|
||||
|
||||
it("strips inline heightening text from description when structured heightening exists", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "entry1",
|
||||
name: "Arcane Prepared Spells",
|
||||
type: "spellcastingEntry",
|
||||
system: {
|
||||
tradition: { value: "arcane" },
|
||||
prepared: { value: "prepared" },
|
||||
spelldc: { dc: 30 },
|
||||
},
|
||||
},
|
||||
{
|
||||
_id: "s1",
|
||||
name: "Chain Lightning",
|
||||
type: "spell",
|
||||
system: {
|
||||
location: { value: "entry1" },
|
||||
level: { value: 6 },
|
||||
traits: { value: ["electricity"] },
|
||||
description: {
|
||||
value:
|
||||
"<p>You discharge a bolt of lightning. The damage is 8d12.</p><p>Heightened (+1) The damage increases by 1d12.</p>",
|
||||
},
|
||||
heightening: {
|
||||
type: "interval",
|
||||
interval: 1,
|
||||
damage: { value: "1d12" },
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const spell = creature.spellcasting?.[0]?.daily
|
||||
?.flatMap((d) => d.spells)
|
||||
.find((s) => s.name === "Chain Lightning");
|
||||
expect(spell?.description).toBe(
|
||||
"You discharge a bolt of lightning. The damage is 8d12.",
|
||||
);
|
||||
expect(spell?.description).not.toContain("Heightened");
|
||||
expect(spell?.heightening).toBe(
|
||||
"Heightened (+1) damage increases by 1d12",
|
||||
);
|
||||
});
|
||||
|
||||
it("formats overlays when heightening is absent", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "entry1",
|
||||
name: "Arcane Innate Spells",
|
||||
type: "spellcastingEntry",
|
||||
system: {
|
||||
tradition: { value: "arcane" },
|
||||
prepared: { value: "innate" },
|
||||
spelldc: { dc: 28 },
|
||||
},
|
||||
},
|
||||
{
|
||||
_id: "s1",
|
||||
name: "Force Barrage",
|
||||
type: "spell",
|
||||
system: {
|
||||
location: { value: "entry1" },
|
||||
level: { value: 1 },
|
||||
traits: { value: ["force", "manipulate"] },
|
||||
description: {
|
||||
value: "<p>You fire darts of force.</p>",
|
||||
},
|
||||
overlays: {
|
||||
variant1: {
|
||||
name: "2 actions",
|
||||
system: {
|
||||
description: {
|
||||
value: "<p>You fire two darts.</p>",
|
||||
},
|
||||
},
|
||||
},
|
||||
variant2: {
|
||||
name: "3 actions",
|
||||
system: {
|
||||
description: {
|
||||
value: "<p>You fire three darts.</p>",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const spell = creature.spellcasting?.[0]?.daily
|
||||
?.flatMap((d) => d.spells)
|
||||
.find((s) => s.name === "Force Barrage");
|
||||
expect(spell?.heightening).toContain("2 actions: You fire two darts.");
|
||||
expect(spell?.heightening).toContain("3 actions: You fire three darts.");
|
||||
});
|
||||
|
||||
it("prefers heightening over overlays when both present", () => {
|
||||
const creature = normalizeFoundryCreature(
|
||||
minimalCreature({
|
||||
items: [
|
||||
{
|
||||
_id: "entry1",
|
||||
name: "Arcane Prepared Spells",
|
||||
type: "spellcastingEntry",
|
||||
system: {
|
||||
tradition: { value: "arcane" },
|
||||
prepared: { value: "prepared" },
|
||||
spelldc: { dc: 30 },
|
||||
},
|
||||
},
|
||||
{
|
||||
_id: "s1",
|
||||
name: "Test Spell",
|
||||
type: "spell",
|
||||
system: {
|
||||
location: { value: "entry1" },
|
||||
level: { value: 1 },
|
||||
traits: { value: [] },
|
||||
heightening: {
|
||||
type: "interval",
|
||||
interval: 2,
|
||||
damage: { value: "1d6" },
|
||||
},
|
||||
overlays: {
|
||||
variant1: {
|
||||
name: "Variant",
|
||||
system: {
|
||||
description: {
|
||||
value: "<p>Should be ignored.</p>",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
const spell = creature.spellcasting?.[0]?.daily
|
||||
?.flatMap((d) => d.spells)
|
||||
.find((s) => s.name === "Test Spell");
|
||||
expect(spell?.heightening).toBe(
|
||||
"Heightened (+2) damage increases by 1d6",
|
||||
);
|
||||
expect(spell?.heightening).not.toContain("Should be ignored");
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -99,9 +99,15 @@ describe("stripFoundryTags", () => {
|
||||
expect(stripFoundryTags("before<hr />after")).toBe("before\nafter");
|
||||
});
|
||||
|
||||
it("strips strong and em tags", () => {
|
||||
it("preserves strong and em tags", () => {
|
||||
expect(stripFoundryTags("<strong>bold</strong> <em>italic</em>")).toBe(
|
||||
"bold italic",
|
||||
"<strong>bold</strong> <em>italic</em>",
|
||||
);
|
||||
});
|
||||
|
||||
it("preserves list tags", () => {
|
||||
expect(stripFoundryTags("<ul><li>first</li><li>second</li></ul>")).toBe(
|
||||
"<ul><li>first</li><li>second</li></ul>",
|
||||
);
|
||||
});
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ import type {
|
||||
DailySpells,
|
||||
LegendaryBlock,
|
||||
SpellcastingBlock,
|
||||
SpellReference,
|
||||
TraitBlock,
|
||||
TraitListItem,
|
||||
TraitSegment,
|
||||
@@ -385,7 +386,7 @@ function normalizeSpellcasting(
|
||||
const block: {
|
||||
name: string;
|
||||
headerText: string;
|
||||
atWill?: string[];
|
||||
atWill?: SpellReference[];
|
||||
daily?: DailySpells[];
|
||||
restLong?: DailySpells[];
|
||||
} = {
|
||||
@@ -396,7 +397,7 @@ function normalizeSpellcasting(
|
||||
const hidden = new Set(sc.hidden ?? []);
|
||||
|
||||
if (sc.will && !hidden.has("will")) {
|
||||
block.atWill = sc.will.map((s) => stripTags(s));
|
||||
block.atWill = sc.will.map((s) => ({ name: stripTags(s) }));
|
||||
}
|
||||
|
||||
if (sc.daily) {
|
||||
@@ -418,7 +419,7 @@ function parseDailyMap(map: Record<string, string[]>): DailySpells[] {
|
||||
return {
|
||||
uses,
|
||||
each,
|
||||
spells: spells.map((s) => stripTags(s)),
|
||||
spells: spells.map((s) => ({ name: stripTags(s) })),
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
@@ -3,7 +3,8 @@ import { type IDBPDatabase, openDB } from "idb";
|
||||
|
||||
const DB_NAME = "initiative-bestiary";
|
||||
const STORE_NAME = "sources";
|
||||
const DB_VERSION = 5;
|
||||
// v8 (2026-04-10): Attack effects, ability frequency, perception details added to PF2e creatures
|
||||
const DB_VERSION = 8;
|
||||
|
||||
interface CachedSourceInfo {
|
||||
readonly sourceCode: string;
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
import type {
|
||||
CreatureId,
|
||||
EquipmentItem,
|
||||
Pf2eCreature,
|
||||
SpellcastingBlock,
|
||||
SpellReference,
|
||||
TraitBlock,
|
||||
} from "@initiative/domain";
|
||||
import { creatureId } from "@initiative/domain";
|
||||
@@ -61,6 +63,7 @@ interface MeleeSystem {
|
||||
bonus?: { value: number };
|
||||
damageRolls?: Record<string, { damage: string; damageType: string }>;
|
||||
traits?: { value: string[] };
|
||||
attackEffects?: { value: string[] };
|
||||
}
|
||||
|
||||
interface ActionSystem {
|
||||
@@ -69,6 +72,7 @@ interface ActionSystem {
|
||||
actions?: { value: number | null };
|
||||
traits?: { value: string[] };
|
||||
description?: { value: string };
|
||||
frequency?: { max: number; per: string };
|
||||
}
|
||||
|
||||
interface SpellcastingEntrySystem {
|
||||
@@ -78,13 +82,106 @@ interface SpellcastingEntrySystem {
|
||||
}
|
||||
|
||||
interface SpellSystem {
|
||||
slug?: string;
|
||||
location?: {
|
||||
value: string;
|
||||
heightenedLevel?: number;
|
||||
uses?: { max: number; value: number };
|
||||
};
|
||||
level?: { value: number };
|
||||
traits?: { rarity?: string; value: string[]; traditions?: string[] };
|
||||
description?: { value: string };
|
||||
range?: { value: string };
|
||||
target?: { value: string };
|
||||
area?: { type?: string; value?: number; details?: string };
|
||||
duration?: { value: string; sustained?: boolean };
|
||||
time?: { value: string };
|
||||
defense?: {
|
||||
save?: { statistic: string; basic?: boolean };
|
||||
passive?: { statistic: string };
|
||||
};
|
||||
heightening?:
|
||||
| {
|
||||
type: "fixed";
|
||||
levels: Record<string, { text?: string }>;
|
||||
}
|
||||
| {
|
||||
type: "interval";
|
||||
interval: number;
|
||||
damage?: { value: string };
|
||||
}
|
||||
| undefined;
|
||||
overlays?: Record<
|
||||
string,
|
||||
{ name?: string; system?: { description?: { value: string } } }
|
||||
>;
|
||||
}
|
||||
|
||||
interface ConsumableSystem {
|
||||
level?: { value: number };
|
||||
traits?: { value: string[] };
|
||||
description?: { value: string };
|
||||
category?: string;
|
||||
spell?: {
|
||||
name: string;
|
||||
system?: { level?: { value: number } };
|
||||
} | null;
|
||||
}
|
||||
|
||||
const EQUIPMENT_TYPES = new Set(["weapon", "consumable", "equipment", "armor"]);
|
||||
|
||||
/** Items shown in the Equipment section with popovers. */
|
||||
function isDetailedEquipment(item: RawFoundryItem): boolean {
|
||||
if (!EQUIPMENT_TYPES.has(item.type)) return false;
|
||||
const sys = item.system;
|
||||
const level = (sys.level as { value: number } | undefined)?.value ?? 0;
|
||||
const traits = (sys.traits as { value: string[] } | undefined)?.value ?? [];
|
||||
// All consumables are tactically relevant (potions, scrolls, poisons, etc.)
|
||||
if (item.type === "consumable") return true;
|
||||
// Magical/invested items
|
||||
if (traits.includes("magical") || traits.includes("invested")) return true;
|
||||
// Special material armor/equipment
|
||||
const material = sys.material as { type: string | null } | undefined;
|
||||
if (material?.type) return true;
|
||||
// Higher-level items
|
||||
if (level > 0) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
/** Items shown on the "Items" line as plain names. */
|
||||
function isMundaneItem(item: RawFoundryItem): boolean {
|
||||
return EQUIPMENT_TYPES.has(item.type) && !isDetailedEquipment(item);
|
||||
}
|
||||
|
||||
function normalizeEquipmentItem(item: RawFoundryItem): EquipmentItem {
|
||||
const sys = item.system;
|
||||
const level = (sys.level as { value: number } | undefined)?.value ?? 0;
|
||||
const traits = (sys.traits as { value: string[] } | undefined)?.value;
|
||||
const rawDesc = (sys.description as { value: string } | undefined)?.value;
|
||||
const description = rawDesc
|
||||
? stripFoundryTags(rawDesc) || undefined
|
||||
: undefined;
|
||||
const category = sys.category as string | undefined;
|
||||
|
||||
let spellName: string | undefined;
|
||||
let spellRank: number | undefined;
|
||||
if (item.type === "consumable") {
|
||||
const spell = (sys as unknown as ConsumableSystem).spell;
|
||||
if (spell) {
|
||||
spellName = spell.name;
|
||||
spellRank = spell.system?.level?.value;
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
name: item.name,
|
||||
level,
|
||||
category: category || undefined,
|
||||
traits: traits && traits.length > 0 ? traits : undefined,
|
||||
description,
|
||||
spellName,
|
||||
spellRank,
|
||||
};
|
||||
}
|
||||
|
||||
const SIZE_MAP: Record<string, string> = {
|
||||
@@ -247,7 +344,17 @@ function formatSpeed(speed: {
|
||||
|
||||
// -- Attack normalization --
|
||||
|
||||
function normalizeAttack(item: RawFoundryItem): TraitBlock {
|
||||
/** Format an attack effect slug to display text: "grab" → "Grab", "lich-siphon-life" → "Siphon Life". */
|
||||
function formatAttackEffect(slug: string, creatureName: string): string {
|
||||
const prefix = `${creatureName.toLowerCase().replaceAll(/[^a-z0-9]+/g, "-")}-`;
|
||||
const stripped = slug.startsWith(prefix) ? slug.slice(prefix.length) : slug;
|
||||
return stripped.split("-").map(capitalize).join(" ");
|
||||
}
|
||||
|
||||
function normalizeAttack(
|
||||
item: RawFoundryItem,
|
||||
creatureName: string,
|
||||
): TraitBlock {
|
||||
const sys = item.system as unknown as MeleeSystem;
|
||||
const bonus = sys.bonus?.value ?? 0;
|
||||
const traits = sys.traits?.value ?? [];
|
||||
@@ -257,13 +364,18 @@ function normalizeAttack(item: RawFoundryItem): TraitBlock {
|
||||
.join(" plus ");
|
||||
const traitStr =
|
||||
traits.length > 0 ? ` (${traits.map(formatTrait).join(", ")})` : "";
|
||||
const effects = sys.attackEffects?.value ?? [];
|
||||
const effectStr =
|
||||
effects.length > 0
|
||||
? ` plus ${effects.map((e) => formatAttackEffect(e, creatureName)).join(" and ")}`
|
||||
: "";
|
||||
return {
|
||||
name: capitalize(item.name),
|
||||
activity: { number: 1, unit: "action" },
|
||||
segments: [
|
||||
{
|
||||
type: "text",
|
||||
value: `+${bonus}${traitStr}, ${damage}`,
|
||||
value: `+${bonus}${traitStr}, ${damage}${effectStr}`,
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -287,15 +399,31 @@ function parseActivity(
|
||||
|
||||
// -- Ability normalization --
|
||||
|
||||
const FREQUENCY_LINE = /(<strong>)?Frequency(<\/strong>)?\s+[^\n]+\n*/i;
|
||||
|
||||
/** Strip the "Frequency once per day" line from ability descriptions when structured frequency data exists. */
|
||||
function stripFrequencyLine(text: string): string {
|
||||
return text.replace(FREQUENCY_LINE, "").trimStart();
|
||||
}
|
||||
|
||||
function normalizeAbility(item: RawFoundryItem): TraitBlock {
|
||||
const sys = item.system as unknown as ActionSystem;
|
||||
const actionType = sys.actionType?.value;
|
||||
const actionCount = sys.actions?.value;
|
||||
const description = stripFoundryTags(sys.description?.value ?? "");
|
||||
let description = stripFoundryTags(sys.description?.value ?? "");
|
||||
const traits = sys.traits?.value ?? [];
|
||||
|
||||
const activity = parseActivity(actionType, actionCount);
|
||||
|
||||
const frequency =
|
||||
sys.frequency?.max != null && sys.frequency.per
|
||||
? `${sys.frequency.max}/${sys.frequency.per}`
|
||||
: undefined;
|
||||
|
||||
if (frequency) {
|
||||
description = stripFrequencyLine(description);
|
||||
}
|
||||
|
||||
const traitStr =
|
||||
traits.length > 0
|
||||
? `(${traits.map((t) => capitalize(formatTrait(t))).join(", ")}) `
|
||||
@@ -306,28 +434,122 @@ function normalizeAbility(item: RawFoundryItem): TraitBlock {
|
||||
? [{ type: "text", value: text }]
|
||||
: [];
|
||||
|
||||
return { name: item.name, activity, segments };
|
||||
return { name: item.name, activity, frequency, segments };
|
||||
}
|
||||
|
||||
// -- Spellcasting normalization --
|
||||
|
||||
function classifySpell(spell: RawFoundryItem): {
|
||||
isCantrip: boolean;
|
||||
rank: number;
|
||||
label: string;
|
||||
} {
|
||||
const sys = spell.system as unknown as SpellSystem;
|
||||
const isCantrip = (sys.traits?.value ?? []).includes("cantrip");
|
||||
const rank = sys.location?.heightenedLevel ?? sys.level?.value ?? 0;
|
||||
const uses = sys.location?.uses;
|
||||
const label =
|
||||
uses && uses.max > 1 ? `${spell.name} (\u00d7${uses.max})` : spell.name;
|
||||
return { isCantrip, rank, label };
|
||||
function formatRange(range: { value: string } | undefined): string | undefined {
|
||||
if (!range?.value) return undefined;
|
||||
return range.value;
|
||||
}
|
||||
|
||||
function formatArea(
|
||||
area: { type?: string; value?: number; details?: string } | undefined,
|
||||
): string | undefined {
|
||||
if (!area) return undefined;
|
||||
if (area.value && area.type) return `${area.value}-foot ${area.type}`;
|
||||
return area.details ?? undefined;
|
||||
}
|
||||
|
||||
function formatDefense(defense: SpellSystem["defense"]): string | undefined {
|
||||
if (!defense) return undefined;
|
||||
if (defense.save) {
|
||||
const stat = capitalize(defense.save.statistic);
|
||||
return defense.save.basic ? `basic ${stat}` : stat;
|
||||
}
|
||||
if (defense.passive) return capitalize(defense.passive.statistic);
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function formatHeightening(
|
||||
heightening: SpellSystem["heightening"],
|
||||
): string | undefined {
|
||||
if (!heightening) return undefined;
|
||||
if (heightening.type === "fixed") {
|
||||
const parts = Object.entries(heightening.levels)
|
||||
.filter(([, lvl]) => lvl.text)
|
||||
.map(
|
||||
([rank, lvl]) =>
|
||||
`Heightened (${rank}) ${stripFoundryTags(lvl.text as string)}`,
|
||||
);
|
||||
return parts.length > 0 ? parts.join("\n") : undefined;
|
||||
}
|
||||
if (heightening.type === "interval") {
|
||||
const dmg = heightening.damage?.value
|
||||
? ` damage increases by ${heightening.damage.value}`
|
||||
: "";
|
||||
return `Heightened (+${heightening.interval})${dmg}`;
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function formatOverlays(overlays: SpellSystem["overlays"]): string | undefined {
|
||||
if (!overlays) return undefined;
|
||||
const parts: string[] = [];
|
||||
for (const overlay of Object.values(overlays)) {
|
||||
const desc = overlay.system?.description?.value;
|
||||
if (!desc) continue;
|
||||
const label = overlay.name ? `${overlay.name}: ` : "";
|
||||
parts.push(`${label}${stripFoundryTags(desc)}`);
|
||||
}
|
||||
return parts.length > 0 ? parts.join("\n") : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Foundry descriptions often include heightening rules inline at the end.
|
||||
* When we extract heightening into a structured field, strip that trailing
|
||||
* text to avoid duplication.
|
||||
*/
|
||||
const HEIGHTENED_SUFFIX = /\s*Heightened\s*\([^)]*\)[\s\S]*$/;
|
||||
|
||||
function normalizeSpell(
|
||||
item: RawFoundryItem,
|
||||
creatureLevel: number,
|
||||
): SpellReference {
|
||||
const sys = item.system as unknown as SpellSystem;
|
||||
const usesMax = sys.location?.uses?.max;
|
||||
const isCantrip = sys.traits?.value?.includes("cantrip") ?? false;
|
||||
const rank =
|
||||
sys.location?.heightenedLevel ??
|
||||
(isCantrip ? Math.ceil(creatureLevel / 2) : (sys.level?.value ?? 0));
|
||||
const heightening =
|
||||
formatHeightening(sys.heightening) ?? formatOverlays(sys.overlays);
|
||||
|
||||
let description: string | undefined;
|
||||
if (sys.description?.value) {
|
||||
let text = stripFoundryTags(sys.description.value);
|
||||
// Resolve Foundry Roll formula references to the spell's actual rank.
|
||||
// The parenthesized form (e.g., "(@item.level)d4") is most common.
|
||||
text = text.replaceAll(/\(?@item\.(?:rank|level)\)?/g, String(rank));
|
||||
if (heightening) {
|
||||
text = text.replace(HEIGHTENED_SUFFIX, "").trim();
|
||||
}
|
||||
description = text || undefined;
|
||||
}
|
||||
|
||||
return {
|
||||
name: item.name,
|
||||
slug: sys.slug,
|
||||
rank,
|
||||
description,
|
||||
traits: sys.traits?.value,
|
||||
traditions: sys.traits?.traditions,
|
||||
range: formatRange(sys.range),
|
||||
target: sys.target?.value || undefined,
|
||||
area: formatArea(sys.area),
|
||||
duration: sys.duration?.value || undefined,
|
||||
defense: formatDefense(sys.defense),
|
||||
actionCost: sys.time?.value || undefined,
|
||||
heightening,
|
||||
usesPerDay: usesMax && usesMax > 1 ? usesMax : undefined,
|
||||
};
|
||||
}
|
||||
|
||||
function normalizeSpellcastingEntry(
|
||||
entry: RawFoundryItem,
|
||||
allSpells: readonly RawFoundryItem[],
|
||||
creatureLevel: number,
|
||||
): SpellcastingBlock {
|
||||
const sys = entry.system as unknown as SpellcastingEntrySystem;
|
||||
const tradition = capitalize(sys.tradition?.value ?? "");
|
||||
@@ -342,26 +564,31 @@ function normalizeSpellcastingEntry(
|
||||
(s) => (s.system as unknown as SpellSystem).location?.value === entry._id,
|
||||
);
|
||||
|
||||
const byRank = new Map<number, string[]>();
|
||||
const cantrips: string[] = [];
|
||||
const byRank = new Map<number, SpellReference[]>();
|
||||
const cantrips: SpellReference[] = [];
|
||||
|
||||
for (const spell of linkedSpells) {
|
||||
const { isCantrip, rank, label } = classifySpell(spell);
|
||||
const ref = normalizeSpell(spell, creatureLevel);
|
||||
const isCantrip =
|
||||
(spell.system as unknown as SpellSystem).traits?.value?.includes(
|
||||
"cantrip",
|
||||
) ?? false;
|
||||
if (isCantrip) {
|
||||
cantrips.push(spell.name);
|
||||
cantrips.push(ref);
|
||||
continue;
|
||||
}
|
||||
const rank = ref.rank ?? 0;
|
||||
const existing = byRank.get(rank) ?? [];
|
||||
existing.push(label);
|
||||
existing.push(ref);
|
||||
byRank.set(rank, existing);
|
||||
}
|
||||
|
||||
const daily = [...byRank.entries()]
|
||||
.sort(([a], [b]) => b - a)
|
||||
.map(([rank, spellNames]) => ({
|
||||
.map(([rank, spells]) => ({
|
||||
uses: rank,
|
||||
each: true,
|
||||
spells: spellNames,
|
||||
spells,
|
||||
}));
|
||||
|
||||
return {
|
||||
@@ -374,10 +601,13 @@ function normalizeSpellcastingEntry(
|
||||
|
||||
function normalizeSpellcasting(
|
||||
items: readonly RawFoundryItem[],
|
||||
creatureLevel: number,
|
||||
): SpellcastingBlock[] {
|
||||
const entries = items.filter((i) => i.type === "spellcastingEntry");
|
||||
const spells = items.filter((i) => i.type === "spell");
|
||||
return entries.map((entry) => normalizeSpellcastingEntry(entry, spells));
|
||||
return entries.map((entry) =>
|
||||
normalizeSpellcastingEntry(entry, spells, creatureLevel),
|
||||
);
|
||||
}
|
||||
|
||||
// -- Main normalization --
|
||||
@@ -487,6 +717,7 @@ export function normalizeFoundryCreature(
|
||||
level: sys.details?.level?.value ?? 0,
|
||||
traits: buildTraits(sys.traits),
|
||||
perception: sys.perception?.mod ?? 0,
|
||||
perceptionDetails: sys.perception?.details || undefined,
|
||||
senses: formatSenses(sys.perception?.senses),
|
||||
languages: formatLanguages(sys.details?.languages),
|
||||
skills: formatSkills(sys.skills),
|
||||
@@ -504,7 +735,9 @@ export function normalizeFoundryCreature(
|
||||
weaknesses: formatWeaknesses(sys.attributes.weaknesses),
|
||||
speed: formatSpeed(sys.attributes.speed),
|
||||
attacks: orUndefined(
|
||||
items.filter((i) => i.type === "melee").map(normalizeAttack),
|
||||
items
|
||||
.filter((i) => i.type === "melee")
|
||||
.map((i) => normalizeAttack(i, r.name)),
|
||||
),
|
||||
abilitiesTop: orUndefined(actionsByCategory(items, "interaction")),
|
||||
abilitiesMid: orUndefined(
|
||||
@@ -516,7 +749,17 @@ export function normalizeFoundryCreature(
|
||||
),
|
||||
),
|
||||
abilitiesBot: orUndefined(actionsByCategory(items, "offensive")),
|
||||
spellcasting: orUndefined(normalizeSpellcasting(items)),
|
||||
spellcasting: orUndefined(
|
||||
normalizeSpellcasting(items, sys.details?.level?.value ?? 0),
|
||||
),
|
||||
items:
|
||||
items
|
||||
.filter(isMundaneItem)
|
||||
.map((i) => i.name)
|
||||
.join(", ") || undefined,
|
||||
equipment: orUndefined(
|
||||
items.filter(isDetailedEquipment).map(normalizeEquipmentItem),
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -69,6 +69,18 @@ export function getCreaturePathsForSource(sourceCode: string): string[] {
|
||||
return compact.creatures.filter((c) => c.s === sourceCode).map((c) => c.f);
|
||||
}
|
||||
|
||||
export function getCreatureNamesByPaths(paths: string[]): Map<string, string> {
|
||||
const compact = rawIndex as unknown as CompactIndex;
|
||||
const pathSet = new Set(paths);
|
||||
const result = new Map<string, string>();
|
||||
for (const c of compact.creatures) {
|
||||
if (pathSet.has(c.f)) {
|
||||
result.set(c.f, c.n);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
export function getPf2eSourceDisplayName(sourceCode: string): string {
|
||||
const index = loadPf2eBestiaryIndex();
|
||||
return index.sources[sourceCode] ?? sourceCode;
|
||||
|
||||
@@ -57,4 +57,5 @@ export interface Pf2eBestiaryIndexPort {
|
||||
getDefaultFetchUrl(sourceCode: string, baseUrl?: string): string;
|
||||
getSourceDisplayName(sourceCode: string): string;
|
||||
getCreaturePathsForSource(sourceCode: string): string[];
|
||||
getCreatureNamesByPaths(paths: string[]): Map<string, string>;
|
||||
}
|
||||
|
||||
@@ -48,5 +48,6 @@ export const productionAdapters: Adapters = {
|
||||
getDefaultFetchUrl: pf2eBestiaryIndex.getDefaultPf2eFetchUrl,
|
||||
getSourceDisplayName: pf2eBestiaryIndex.getPf2eSourceDisplayName,
|
||||
getCreaturePathsForSource: pf2eBestiaryIndex.getCreaturePathsForSource,
|
||||
getCreatureNamesByPaths: pf2eBestiaryIndex.getCreatureNamesByPaths,
|
||||
},
|
||||
};
|
||||
|
||||
@@ -8,7 +8,13 @@
|
||||
|
||||
function formatDamage(params: string): string {
|
||||
// "3d6+10[fire]" → "3d6+10 fire"
|
||||
return params.replaceAll(/\[([^\]]*)\]/g, " $1").trim();
|
||||
// "d4[persistent,fire]" → "d4 persistent fire"
|
||||
return params
|
||||
.replaceAll(
|
||||
/\[([^\]]*)\]/g,
|
||||
(_, type: string) => ` ${type.replaceAll(",", " ")}`,
|
||||
)
|
||||
.trim();
|
||||
}
|
||||
|
||||
function formatCheck(params: string): string {
|
||||
@@ -80,11 +86,11 @@ export function stripFoundryTags(html: string): string {
|
||||
// Strip action-glyph spans (content is a number the renderer handles)
|
||||
result = result.replaceAll(/<span class="action-glyph">[^<]*<\/span>/gi, "");
|
||||
|
||||
// Strip HTML tags
|
||||
// Strip HTML tags (preserve <strong> for UI rendering)
|
||||
result = result.replaceAll(/<br\s*\/?>/gi, "\n");
|
||||
result = result.replaceAll(/<hr\s*\/?>/gi, "\n");
|
||||
result = result.replaceAll(/<\/p>\s*<p[^>]*>/gi, "\n");
|
||||
result = result.replaceAll(/<[^>]+>/g, "");
|
||||
result = result.replaceAll(/<(?!\/?(?:strong|em|ul|ol|li)\b)[^>]+>/g, "");
|
||||
|
||||
// Decode common HTML entities
|
||||
result = result.replaceAll("&", "&");
|
||||
@@ -92,6 +98,11 @@ export function stripFoundryTags(html: string): string {
|
||||
result = result.replaceAll(">", ">");
|
||||
result = result.replaceAll(""", '"');
|
||||
|
||||
// Collapse whitespace around list tags so they don't create extra
|
||||
// line breaks when rendered with whitespace-pre-line
|
||||
result = result.replaceAll(/\s*(<\/?(?:ul|ol)>)\s*/g, "$1");
|
||||
result = result.replaceAll(/\s*(<\/?li>)\s*/g, "$1");
|
||||
|
||||
// Collapse whitespace
|
||||
result = result.replaceAll(/[ \t]+/g, " ");
|
||||
result = result.replaceAll(/\n\s*\n/g, "\n");
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
// @vitest-environment jsdom
|
||||
import "@testing-library/jest-dom/vitest";
|
||||
|
||||
import type { EquipmentItem } from "@initiative/domain";
|
||||
import { cleanup, fireEvent, render, screen } from "@testing-library/react";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { EquipmentDetailPopover } from "../equipment-detail-popover.js";
|
||||
|
||||
afterEach(cleanup);
|
||||
|
||||
const POISON: EquipmentItem = {
|
||||
name: "Giant Wasp Venom",
|
||||
level: 7,
|
||||
category: "poison",
|
||||
traits: ["consumable", "poison", "injury"],
|
||||
description: "A deadly poison extracted from giant wasps.",
|
||||
};
|
||||
|
||||
const SCROLL: EquipmentItem = {
|
||||
name: "Scroll of Teleport",
|
||||
level: 11,
|
||||
category: "scroll",
|
||||
traits: ["consumable", "magical", "scroll"],
|
||||
description: "A scroll containing Teleport.",
|
||||
spellName: "Teleport",
|
||||
spellRank: 6,
|
||||
};
|
||||
|
||||
const ANCHOR: DOMRect = new DOMRect(100, 100, 50, 20);
|
||||
const SCROLL_SPELL_REGEX = /Teleport \(Rank 6\)/;
|
||||
const DIALOG_LABEL_REGEX = /Equipment details: Giant Wasp Venom/;
|
||||
|
||||
beforeEach(() => {
|
||||
Object.defineProperty(globalThis, "matchMedia", {
|
||||
writable: true,
|
||||
configurable: true,
|
||||
value: vi.fn().mockImplementation(() => ({
|
||||
matches: true,
|
||||
media: "(min-width: 1024px)",
|
||||
onchange: null,
|
||||
addEventListener: vi.fn(),
|
||||
removeEventListener: vi.fn(),
|
||||
addListener: vi.fn(),
|
||||
removeListener: vi.fn(),
|
||||
dispatchEvent: vi.fn(),
|
||||
})),
|
||||
});
|
||||
});
|
||||
|
||||
describe("EquipmentDetailPopover", () => {
|
||||
it("renders item name, level, traits, and description", () => {
|
||||
render(
|
||||
<EquipmentDetailPopover
|
||||
item={POISON}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText("Giant Wasp Venom")).toBeInTheDocument();
|
||||
expect(screen.getByText("7")).toBeInTheDocument();
|
||||
expect(screen.getByText("consumable")).toBeInTheDocument();
|
||||
expect(screen.getByText("poison")).toBeInTheDocument();
|
||||
expect(screen.getByText("injury")).toBeInTheDocument();
|
||||
expect(
|
||||
screen.getByText("A deadly poison extracted from giant wasps."),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders scroll/wand spell info", () => {
|
||||
render(
|
||||
<EquipmentDetailPopover
|
||||
item={SCROLL}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText(SCROLL_SPELL_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("calls onClose when Escape is pressed", () => {
|
||||
const onClose = vi.fn();
|
||||
render(
|
||||
<EquipmentDetailPopover
|
||||
item={POISON}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={onClose}
|
||||
/>,
|
||||
);
|
||||
fireEvent.keyDown(document, { key: "Escape" });
|
||||
expect(onClose).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("uses the dialog role with the item name as label", () => {
|
||||
render(
|
||||
<EquipmentDetailPopover
|
||||
item={POISON}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(
|
||||
screen.getByRole("dialog", {
|
||||
name: DIALOG_LABEL_REGEX,
|
||||
}),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
@@ -4,11 +4,14 @@ import "@testing-library/jest-dom/vitest";
|
||||
import type { Pf2eCreature } from "@initiative/domain";
|
||||
import { creatureId } from "@initiative/domain";
|
||||
import { cleanup, render, screen } from "@testing-library/react";
|
||||
import { afterEach, describe, expect, it } from "vitest";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { Pf2eStatBlock } from "../pf2e-stat-block.js";
|
||||
|
||||
afterEach(cleanup);
|
||||
|
||||
const USES_PER_DAY_REGEX = /×3/;
|
||||
const HEAL_DESCRIPTION_REGEX = /channel positive energy/;
|
||||
const PERCEPTION_SENSES_REGEX = /\+2.*Darkvision/;
|
||||
const SKILLS_REGEX = /Acrobatics \+5.*Stealth \+5/;
|
||||
const SAVE_CONDITIONAL_REGEX = /\+12.*\+1 status to all saves vs\. magic/;
|
||||
@@ -22,6 +25,13 @@ const ABILITY_MID_NAME_REGEX = /Goblin Scuttle/;
|
||||
const ABILITY_MID_DESC_REGEX = /The goblin Steps\./;
|
||||
const CANTRIPS_REGEX = /Cantrips:/;
|
||||
const AC_REGEX = /16/;
|
||||
const RK_DC_13_REGEX = /DC 13/;
|
||||
const RK_DC_15_REGEX = /DC 15/;
|
||||
const RK_DC_25_REGEX = /DC 25/;
|
||||
const RK_HUMANOID_SOCIETY_REGEX = /Humanoid \(Society\)/;
|
||||
const RK_UNDEAD_RELIGION_REGEX = /Undead \(Religion\)/;
|
||||
const RK_BEAST_SKILLS_REGEX = /Beast \(Arcana\/Nature\)/;
|
||||
const SCROLL_NAME_REGEX = /Scroll of Teleport/;
|
||||
|
||||
const GOBLIN_WARRIOR: Pf2eCreature = {
|
||||
system: "pf2e",
|
||||
@@ -90,9 +100,13 @@ const NAUNET: Pf2eCreature = {
|
||||
name: "Divine Innate Spells",
|
||||
headerText: "DC 25, attack +17",
|
||||
daily: [
|
||||
{ uses: 4, each: true, spells: ["Unfettered Movement (Constant)"] },
|
||||
{
|
||||
uses: 4,
|
||||
each: true,
|
||||
spells: [{ name: "Unfettered Movement (Constant)" }],
|
||||
},
|
||||
],
|
||||
atWill: ["Detect Magic"],
|
||||
atWill: [{ name: "Detect Magic" }],
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -147,6 +161,53 @@ describe("Pf2eStatBlock", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("recall knowledge", () => {
|
||||
it("renders Recall Knowledge line for a creature with a recognized type trait", () => {
|
||||
renderStatBlock(GOBLIN_WARRIOR);
|
||||
expect(screen.getByText("Recall Knowledge")).toBeInTheDocument();
|
||||
expect(screen.getByText(RK_DC_13_REGEX)).toBeInTheDocument();
|
||||
expect(screen.getByText(RK_HUMANOID_SOCIETY_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("adjusts DC for uncommon rarity", () => {
|
||||
const uncommonCreature: Pf2eCreature = {
|
||||
...GOBLIN_WARRIOR,
|
||||
traits: ["uncommon", "small", "humanoid"],
|
||||
};
|
||||
renderStatBlock(uncommonCreature);
|
||||
expect(screen.getByText(RK_DC_15_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("adjusts DC for rare rarity", () => {
|
||||
const rareCreature: Pf2eCreature = {
|
||||
...GOBLIN_WARRIOR,
|
||||
level: 5,
|
||||
traits: ["rare", "medium", "undead"],
|
||||
};
|
||||
renderStatBlock(rareCreature);
|
||||
expect(screen.getByText(RK_DC_25_REGEX)).toBeInTheDocument();
|
||||
expect(screen.getByText(RK_UNDEAD_RELIGION_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("shows multiple skills for types with dual skill mapping", () => {
|
||||
const beastCreature: Pf2eCreature = {
|
||||
...GOBLIN_WARRIOR,
|
||||
traits: ["small", "beast"],
|
||||
};
|
||||
renderStatBlock(beastCreature);
|
||||
expect(screen.getByText(RK_BEAST_SKILLS_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("omits Recall Knowledge when no type trait is recognized", () => {
|
||||
const noTypeCreature: Pf2eCreature = {
|
||||
...GOBLIN_WARRIOR,
|
||||
traits: ["small", "goblin"],
|
||||
};
|
||||
renderStatBlock(noTypeCreature);
|
||||
expect(screen.queryByText("Recall Knowledge")).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe("perception and senses", () => {
|
||||
it("renders perception modifier and senses", () => {
|
||||
renderStatBlock(GOBLIN_WARRIOR);
|
||||
@@ -277,4 +338,160 @@ describe("Pf2eStatBlock", () => {
|
||||
expect(screen.queryByText(CANTRIPS_REGEX)).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe("equipment section", () => {
|
||||
const CREATURE_WITH_EQUIPMENT: Pf2eCreature = {
|
||||
...GOBLIN_WARRIOR,
|
||||
id: creatureId("test:equipped"),
|
||||
name: "Equipped NPC",
|
||||
items: "longsword, leather armor",
|
||||
equipment: [
|
||||
{
|
||||
name: "Giant Wasp Venom",
|
||||
level: 7,
|
||||
category: "poison",
|
||||
traits: ["consumable", "poison"],
|
||||
description: "A deadly poison extracted from giant wasps.",
|
||||
},
|
||||
{
|
||||
name: "Scroll of Teleport",
|
||||
level: 11,
|
||||
category: "scroll",
|
||||
traits: ["consumable", "magical", "scroll"],
|
||||
description: "A scroll containing Teleport.",
|
||||
spellName: "Teleport",
|
||||
spellRank: 6,
|
||||
},
|
||||
{
|
||||
name: "Plain Talisman",
|
||||
level: 1,
|
||||
traits: ["magical"],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
it("renders Equipment section with item names", () => {
|
||||
renderStatBlock(CREATURE_WITH_EQUIPMENT);
|
||||
expect(
|
||||
screen.getByRole("heading", { name: "Equipment" }),
|
||||
).toBeInTheDocument();
|
||||
expect(screen.getByText("Giant Wasp Venom")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders scroll name as-is from Foundry data", () => {
|
||||
renderStatBlock(CREATURE_WITH_EQUIPMENT);
|
||||
expect(screen.getByText(SCROLL_NAME_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("does not render Equipment section when creature has no equipment", () => {
|
||||
renderStatBlock(GOBLIN_WARRIOR);
|
||||
expect(
|
||||
screen.queryByRole("heading", { name: "Equipment" }),
|
||||
).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders equipment items with descriptions as clickable buttons", () => {
|
||||
renderStatBlock(CREATURE_WITH_EQUIPMENT);
|
||||
expect(
|
||||
screen.getByRole("button", { name: "Giant Wasp Venom" }),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders equipment items without descriptions as plain text", () => {
|
||||
renderStatBlock(CREATURE_WITH_EQUIPMENT);
|
||||
expect(
|
||||
screen.queryByRole("button", { name: "Plain Talisman" }),
|
||||
).not.toBeInTheDocument();
|
||||
expect(screen.getByText("Plain Talisman")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders Items line with mundane item names", () => {
|
||||
renderStatBlock(CREATURE_WITH_EQUIPMENT);
|
||||
expect(screen.getByText("Items")).toBeInTheDocument();
|
||||
expect(screen.getByText("longsword, leather armor")).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe("clickable spells", () => {
|
||||
const SPELLCASTER: Pf2eCreature = {
|
||||
...NAUNET,
|
||||
id: creatureId("test:spellcaster"),
|
||||
name: "Spellcaster",
|
||||
spellcasting: [
|
||||
{
|
||||
name: "Divine Innate Spells",
|
||||
headerText: "DC 30, attack +20",
|
||||
atWill: [{ name: "Detect Magic", rank: 1 }],
|
||||
daily: [
|
||||
{
|
||||
uses: 4,
|
||||
each: true,
|
||||
spells: [
|
||||
{
|
||||
name: "Heal",
|
||||
description: "You channel positive energy to heal.",
|
||||
rank: 4,
|
||||
usesPerDay: 3,
|
||||
},
|
||||
{ name: "Restoration", rank: 4 },
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
Object.defineProperty(globalThis, "matchMedia", {
|
||||
writable: true,
|
||||
configurable: true,
|
||||
value: vi.fn().mockImplementation(() => ({
|
||||
matches: true,
|
||||
media: "(min-width: 1024px)",
|
||||
onchange: null,
|
||||
addEventListener: vi.fn(),
|
||||
removeEventListener: vi.fn(),
|
||||
addListener: vi.fn(),
|
||||
removeListener: vi.fn(),
|
||||
dispatchEvent: vi.fn(),
|
||||
})),
|
||||
});
|
||||
});
|
||||
|
||||
it("renders a spell with a description as a clickable button", () => {
|
||||
renderStatBlock(SPELLCASTER);
|
||||
expect(screen.getByRole("button", { name: "Heal" })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders a spell without description as plain text (not a button)", () => {
|
||||
renderStatBlock(SPELLCASTER);
|
||||
expect(
|
||||
screen.queryByRole("button", { name: "Restoration" }),
|
||||
).not.toBeInTheDocument();
|
||||
expect(screen.getByText("Restoration")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders usesPerDay as plain text alongside the spell button", () => {
|
||||
renderStatBlock(SPELLCASTER);
|
||||
expect(screen.getByText(USES_PER_DAY_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("opens the spell popover when a spell button is clicked", async () => {
|
||||
const user = userEvent.setup();
|
||||
renderStatBlock(SPELLCASTER);
|
||||
await user.click(screen.getByRole("button", { name: "Heal" }));
|
||||
expect(screen.getByText(HEAL_DESCRIPTION_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("closes the popover when Escape is pressed", async () => {
|
||||
const user = userEvent.setup();
|
||||
renderStatBlock(SPELLCASTER);
|
||||
await user.click(screen.getByRole("button", { name: "Heal" }));
|
||||
expect(screen.getByText(HEAL_DESCRIPTION_REGEX)).toBeInTheDocument();
|
||||
await user.keyboard("{Escape}");
|
||||
expect(
|
||||
screen.queryByText(HEAL_DESCRIPTION_REGEX),
|
||||
).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -65,7 +65,7 @@ describe("SourceFetchPrompt", () => {
|
||||
});
|
||||
|
||||
it("Load calls fetchAndCacheSource and onSourceLoaded on success", async () => {
|
||||
mockFetchAndCacheSource.mockResolvedValueOnce(undefined);
|
||||
mockFetchAndCacheSource.mockResolvedValueOnce({ skippedNames: [] });
|
||||
const user = userEvent.setup();
|
||||
const { onSourceLoaded } = renderPrompt();
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ beforeAll(() => {
|
||||
|
||||
afterEach(cleanup);
|
||||
|
||||
function renderWithSources(sources: CachedSourceInfo[] = []) {
|
||||
function renderWithSources(sources: CachedSourceInfo[] = []): void {
|
||||
const adapters = createTestAdapters();
|
||||
// Wire getCachedSources to return the provided sources initially,
|
||||
// then empty after clear operations
|
||||
@@ -57,14 +57,14 @@ function renderWithSources(sources: CachedSourceInfo[] = []) {
|
||||
|
||||
describe("SourceManager", () => {
|
||||
it("shows 'No cached sources' empty state when no sources", async () => {
|
||||
void renderWithSources([]);
|
||||
renderWithSources([]);
|
||||
await waitFor(() => {
|
||||
expect(screen.getByText("No cached sources")).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
it("lists cached sources with display name and creature count", async () => {
|
||||
void renderWithSources([
|
||||
renderWithSources([
|
||||
{
|
||||
sourceCode: "mm",
|
||||
displayName: "Monster Manual",
|
||||
@@ -88,7 +88,7 @@ describe("SourceManager", () => {
|
||||
|
||||
it("Clear All button removes all sources", async () => {
|
||||
const user = userEvent.setup();
|
||||
void renderWithSources([
|
||||
renderWithSources([
|
||||
{
|
||||
sourceCode: "mm",
|
||||
displayName: "Monster Manual",
|
||||
@@ -110,7 +110,7 @@ describe("SourceManager", () => {
|
||||
|
||||
it("individual source delete button removes that source", async () => {
|
||||
const user = userEvent.setup();
|
||||
void renderWithSources([
|
||||
renderWithSources([
|
||||
{
|
||||
sourceCode: "mm",
|
||||
displayName: "Monster Manual",
|
||||
|
||||
158
apps/web/src/components/__tests__/spell-detail-popover.test.tsx
Normal file
158
apps/web/src/components/__tests__/spell-detail-popover.test.tsx
Normal file
@@ -0,0 +1,158 @@
|
||||
// @vitest-environment jsdom
|
||||
import "@testing-library/jest-dom/vitest";
|
||||
|
||||
import type { SpellReference } from "@initiative/domain";
|
||||
import { cleanup, fireEvent, render, screen } from "@testing-library/react";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { SpellDetailPopover } from "../spell-detail-popover.js";
|
||||
|
||||
afterEach(cleanup);
|
||||
|
||||
const FIREBALL: SpellReference = {
|
||||
name: "Fireball",
|
||||
slug: "fireball",
|
||||
rank: 3,
|
||||
description: "A spark leaps from your fingertip to the target.",
|
||||
traits: ["fire", "manipulate"],
|
||||
traditions: ["arcane", "primal"],
|
||||
range: "500 feet",
|
||||
area: "20-foot burst",
|
||||
defense: "basic Reflex",
|
||||
actionCost: "2",
|
||||
heightening: "Heightened (+1) The damage increases by 2d6.",
|
||||
};
|
||||
|
||||
const ANCHOR: DOMRect = new DOMRect(100, 100, 50, 20);
|
||||
|
||||
const SPARK_LEAPS_REGEX = /spark leaps/;
|
||||
const HEIGHTENED_REGEX = /Heightened.*2d6/;
|
||||
const RANGE_REGEX = /500 feet/;
|
||||
const AREA_REGEX = /20-foot burst/;
|
||||
const DEFENSE_REGEX = /basic Reflex/;
|
||||
const NO_DESCRIPTION_REGEX = /No description available/;
|
||||
const DIALOG_LABEL_REGEX = /Spell details: Fireball/;
|
||||
|
||||
beforeEach(() => {
|
||||
// Force desktop variant in jsdom
|
||||
Object.defineProperty(globalThis, "matchMedia", {
|
||||
writable: true,
|
||||
configurable: true,
|
||||
value: vi.fn().mockImplementation(() => ({
|
||||
matches: true,
|
||||
media: "(min-width: 1024px)",
|
||||
onchange: null,
|
||||
addEventListener: vi.fn(),
|
||||
removeEventListener: vi.fn(),
|
||||
addListener: vi.fn(),
|
||||
removeListener: vi.fn(),
|
||||
dispatchEvent: vi.fn(),
|
||||
})),
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpellDetailPopover", () => {
|
||||
it("renders spell name, rank, traits, and description", () => {
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={FIREBALL}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText("Fireball")).toBeInTheDocument();
|
||||
expect(screen.getByText("3rd")).toBeInTheDocument();
|
||||
expect(screen.getByText("fire")).toBeInTheDocument();
|
||||
expect(screen.getByText("manipulate")).toBeInTheDocument();
|
||||
expect(screen.getByText(SPARK_LEAPS_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders heightening rules when present", () => {
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={FIREBALL}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText(HEIGHTENED_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders range, area, and defense", () => {
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={FIREBALL}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText(RANGE_REGEX)).toBeInTheDocument();
|
||||
expect(screen.getByText(AREA_REGEX)).toBeInTheDocument();
|
||||
expect(screen.getByText(DEFENSE_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("calls onClose when Escape is pressed", () => {
|
||||
const onClose = vi.fn();
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={FIREBALL}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={onClose}
|
||||
/>,
|
||||
);
|
||||
fireEvent.keyDown(document, { key: "Escape" });
|
||||
expect(onClose).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("shows placeholder when description is missing", () => {
|
||||
const spell: SpellReference = { name: "Mystery", rank: 1 };
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={spell}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText(NO_DESCRIPTION_REGEX)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders the action cost as an icon when it is a numeric action count", () => {
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={FIREBALL}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
// Action cost "2" renders as an SVG ActivityIcon (portaled to body)
|
||||
const dialog = screen.getByRole("dialog");
|
||||
expect(dialog.querySelector("svg")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders non-numeric action cost as text", () => {
|
||||
const spell: SpellReference = {
|
||||
...FIREBALL,
|
||||
actionCost: "1 minute",
|
||||
};
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={spell}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText("1 minute")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("uses the dialog role with the spell name as label", () => {
|
||||
render(
|
||||
<SpellDetailPopover
|
||||
spell={FIREBALL}
|
||||
anchorRect={ANCHOR}
|
||||
onClose={() => {}}
|
||||
/>,
|
||||
);
|
||||
expect(
|
||||
screen.getByRole("dialog", { name: DIALOG_LABEL_REGEX }),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
@@ -111,9 +111,15 @@ const DRAGON: Creature = {
|
||||
{
|
||||
name: "Innate Spellcasting",
|
||||
headerText: "The dragon's spellcasting ability is Charisma.",
|
||||
atWill: ["detect magic", "suggestion"],
|
||||
daily: [{ uses: 3, each: true, spells: ["fireball", "wall of fire"] }],
|
||||
restLong: [{ uses: 1, each: false, spells: ["wish"] }],
|
||||
atWill: [{ name: "detect magic" }, { name: "suggestion" }],
|
||||
daily: [
|
||||
{
|
||||
uses: 3,
|
||||
each: true,
|
||||
spells: [{ name: "fireball" }, { name: "wall of fire" }],
|
||||
},
|
||||
],
|
||||
restLong: [{ uses: 1, each: false, spells: [{ name: "wish" }] }],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
141
apps/web/src/components/detail-popover.tsx
Normal file
141
apps/web/src/components/detail-popover.tsx
Normal file
@@ -0,0 +1,141 @@
|
||||
import type { ReactNode } from "react";
|
||||
import { useEffect, useLayoutEffect, useRef, useState } from "react";
|
||||
import { createPortal } from "react-dom";
|
||||
import { useClickOutside } from "../hooks/use-click-outside.js";
|
||||
import { useSwipeToDismissDown } from "../hooks/use-swipe-to-dismiss.js";
|
||||
import { cn } from "../lib/utils.js";
|
||||
|
||||
interface DetailPopoverProps {
|
||||
readonly anchorRect: DOMRect;
|
||||
readonly onClose: () => void;
|
||||
readonly ariaLabel: string;
|
||||
readonly children: ReactNode;
|
||||
}
|
||||
|
||||
function DesktopPanel({
|
||||
anchorRect,
|
||||
onClose,
|
||||
ariaLabel,
|
||||
children,
|
||||
}: Readonly<DetailPopoverProps>) {
|
||||
const ref = useRef<HTMLDivElement>(null);
|
||||
const [pos, setPos] = useState<{ top: number; left: number } | null>(null);
|
||||
|
||||
useLayoutEffect(() => {
|
||||
const el = ref.current;
|
||||
if (!el) return;
|
||||
const popover = el.getBoundingClientRect();
|
||||
const vw = document.documentElement.clientWidth;
|
||||
const vh = document.documentElement.clientHeight;
|
||||
// Prefer placement to the LEFT of the anchor (panel is on the right edge)
|
||||
let left = anchorRect.left - popover.width - 8;
|
||||
if (left < 8) {
|
||||
left = anchorRect.right + 8;
|
||||
}
|
||||
if (left + popover.width > vw - 8) {
|
||||
left = vw - popover.width - 8;
|
||||
}
|
||||
let top = anchorRect.top;
|
||||
if (top + popover.height > vh - 8) {
|
||||
top = vh - popover.height - 8;
|
||||
}
|
||||
if (top < 8) top = 8;
|
||||
setPos({ top, left });
|
||||
}, [anchorRect]);
|
||||
|
||||
useClickOutside(ref, onClose);
|
||||
|
||||
return (
|
||||
<div
|
||||
ref={ref}
|
||||
className="card-glow fixed z-50 max-h-[calc(100vh-16px)] w-80 max-w-[calc(100vw-16px)] overflow-y-auto rounded-lg border border-border bg-card p-4 shadow-lg"
|
||||
style={pos ? { top: pos.top, left: pos.left } : { visibility: "hidden" }}
|
||||
role="dialog"
|
||||
aria-label={ariaLabel}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function MobileSheet({
|
||||
onClose,
|
||||
ariaLabel,
|
||||
children,
|
||||
}: Readonly<Omit<DetailPopoverProps, "anchorRect">>) {
|
||||
const { offsetY, isSwiping, handlers } = useSwipeToDismissDown(onClose);
|
||||
|
||||
useEffect(() => {
|
||||
const handler = (e: KeyboardEvent) => {
|
||||
if (e.key === "Escape") onClose();
|
||||
};
|
||||
document.addEventListener("keydown", handler);
|
||||
return () => document.removeEventListener("keydown", handler);
|
||||
}, [onClose]);
|
||||
|
||||
return (
|
||||
<div className="fixed inset-0 z-50">
|
||||
<button
|
||||
type="button"
|
||||
className="fade-in absolute inset-0 animate-in bg-black/50"
|
||||
onClick={onClose}
|
||||
aria-label="Close details"
|
||||
/>
|
||||
<div
|
||||
className={cn(
|
||||
"panel-glow absolute right-0 bottom-0 left-0 max-h-[80vh] rounded-t-2xl border-border border-t bg-card",
|
||||
!isSwiping && "animate-slide-in-bottom",
|
||||
)}
|
||||
style={
|
||||
isSwiping ? { transform: `translateY(${offsetY}px)` } : undefined
|
||||
}
|
||||
{...handlers}
|
||||
role="dialog"
|
||||
aria-label={ariaLabel}
|
||||
>
|
||||
<div className="flex justify-center pt-2 pb-1">
|
||||
<div className="h-1 w-10 rounded-full bg-muted-foreground/40" />
|
||||
</div>
|
||||
<div className="max-h-[calc(80vh-24px)] overflow-y-auto p-4">
|
||||
{children}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function DetailPopover({
|
||||
anchorRect,
|
||||
onClose,
|
||||
ariaLabel,
|
||||
children,
|
||||
}: Readonly<DetailPopoverProps>) {
|
||||
const [isDesktop, setIsDesktop] = useState(
|
||||
() => globalThis.matchMedia("(min-width: 1024px)").matches,
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
const mq = globalThis.matchMedia("(min-width: 1024px)");
|
||||
const handler = (e: MediaQueryListEvent) => setIsDesktop(e.matches);
|
||||
mq.addEventListener("change", handler);
|
||||
return () => mq.removeEventListener("change", handler);
|
||||
}, []);
|
||||
|
||||
// Portal to document.body to escape any CSS transforms on ancestors
|
||||
// (the side panel uses translate-x for collapse animation, which would
|
||||
// otherwise become the containing block for fixed-positioned children).
|
||||
const content = isDesktop ? (
|
||||
<DesktopPanel
|
||||
anchorRect={anchorRect}
|
||||
onClose={onClose}
|
||||
ariaLabel={ariaLabel}
|
||||
>
|
||||
{children}
|
||||
</DesktopPanel>
|
||||
) : (
|
||||
<MobileSheet onClose={onClose} ariaLabel={ariaLabel}>
|
||||
{children}
|
||||
</MobileSheet>
|
||||
);
|
||||
return createPortal(content, document.body);
|
||||
}
|
||||
@@ -134,7 +134,7 @@ export function DndStatBlock({ creature }: Readonly<DndStatBlockProps>) {
|
||||
{sc.atWill && sc.atWill.length > 0 && (
|
||||
<div className="pl-2">
|
||||
<span className="font-semibold">At Will:</span>{" "}
|
||||
{sc.atWill.join(", ")}
|
||||
{sc.atWill.map((s) => s.name).join(", ")}
|
||||
</div>
|
||||
)}
|
||||
{sc.daily?.map((d) => (
|
||||
@@ -143,7 +143,7 @@ export function DndStatBlock({ creature }: Readonly<DndStatBlockProps>) {
|
||||
{d.uses}/day
|
||||
{d.each ? " each" : ""}:
|
||||
</span>{" "}
|
||||
{d.spells.join(", ")}
|
||||
{d.spells.map((s) => s.name).join(", ")}
|
||||
</div>
|
||||
))}
|
||||
{sc.restLong?.map((d) => (
|
||||
@@ -155,7 +155,7 @@ export function DndStatBlock({ creature }: Readonly<DndStatBlockProps>) {
|
||||
{d.uses}/long rest
|
||||
{d.each ? " each" : ""}:
|
||||
</span>{" "}
|
||||
{d.spells.join(", ")}
|
||||
{d.spells.map((s) => s.name).join(", ")}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
|
||||
72
apps/web/src/components/equipment-detail-popover.tsx
Normal file
72
apps/web/src/components/equipment-detail-popover.tsx
Normal file
@@ -0,0 +1,72 @@
|
||||
import type { EquipmentItem } from "@initiative/domain";
|
||||
import { DetailPopover } from "./detail-popover.js";
|
||||
import { RichDescription } from "./rich-description.js";
|
||||
|
||||
interface EquipmentDetailPopoverProps {
|
||||
readonly item: EquipmentItem;
|
||||
readonly anchorRect: DOMRect;
|
||||
readonly onClose: () => void;
|
||||
}
|
||||
|
||||
function EquipmentDetailContent({ item }: Readonly<{ item: EquipmentItem }>) {
|
||||
return (
|
||||
<div className="space-y-2 text-sm">
|
||||
<h3 className="font-bold text-lg text-stat-heading">{item.name}</h3>
|
||||
{item.traits && item.traits.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1">
|
||||
{item.traits.map((t) => (
|
||||
<span
|
||||
key={t}
|
||||
className="rounded border border-border bg-card px-1.5 py-0.5 text-foreground text-xs"
|
||||
>
|
||||
{t}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
<div className="space-y-0.5 text-xs">
|
||||
<div>
|
||||
<span className="font-semibold">Level</span> {item.level}
|
||||
</div>
|
||||
{item.category ? (
|
||||
<div>
|
||||
<span className="font-semibold">Category</span>{" "}
|
||||
{item.category.charAt(0).toUpperCase() + item.category.slice(1)}
|
||||
</div>
|
||||
) : null}
|
||||
{item.spellName ? (
|
||||
<div>
|
||||
<span className="font-semibold">Spell</span> {item.spellName}
|
||||
{item.spellRank === undefined ? "" : ` (Rank ${item.spellRank})`}
|
||||
</div>
|
||||
) : null}
|
||||
</div>
|
||||
{item.description ? (
|
||||
<RichDescription
|
||||
text={item.description}
|
||||
className="whitespace-pre-line text-foreground"
|
||||
/>
|
||||
) : (
|
||||
<p className="text-muted-foreground italic">
|
||||
No description available.
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function EquipmentDetailPopover({
|
||||
item,
|
||||
anchorRect,
|
||||
onClose,
|
||||
}: Readonly<EquipmentDetailPopoverProps>) {
|
||||
return (
|
||||
<DetailPopover
|
||||
anchorRect={anchorRect}
|
||||
onClose={onClose}
|
||||
ariaLabel={`Equipment details: ${item.name}`}
|
||||
>
|
||||
<EquipmentDetailContent item={item} />
|
||||
</DetailPopover>
|
||||
);
|
||||
}
|
||||
@@ -1,5 +1,12 @@
|
||||
import type { Pf2eCreature } from "@initiative/domain";
|
||||
import { formatInitiativeModifier } from "@initiative/domain";
|
||||
import type {
|
||||
EquipmentItem,
|
||||
Pf2eCreature,
|
||||
SpellReference,
|
||||
} from "@initiative/domain";
|
||||
import { formatInitiativeModifier, recallKnowledge } from "@initiative/domain";
|
||||
import { useCallback, useRef, useState } from "react";
|
||||
import { EquipmentDetailPopover } from "./equipment-detail-popover.js";
|
||||
import { SpellDetailPopover } from "./spell-detail-popover.js";
|
||||
import {
|
||||
PropertyLine,
|
||||
SectionDivider,
|
||||
@@ -34,7 +41,123 @@ function formatMod(mod: number): string {
|
||||
return mod >= 0 ? `+${mod}` : `${mod}`;
|
||||
}
|
||||
|
||||
interface SpellLinkProps {
|
||||
readonly spell: SpellReference;
|
||||
readonly onOpen: (spell: SpellReference, rect: DOMRect) => void;
|
||||
}
|
||||
|
||||
function UsesPerDay({ count }: Readonly<{ count: number | undefined }>) {
|
||||
if (count === undefined || count <= 1) return null;
|
||||
return <span> (×{count})</span>;
|
||||
}
|
||||
|
||||
function SpellLink({ spell, onOpen }: Readonly<SpellLinkProps>) {
|
||||
const ref = useRef<HTMLButtonElement>(null);
|
||||
const handleClick = useCallback(() => {
|
||||
if (!spell.description) return;
|
||||
const rect = ref.current?.getBoundingClientRect();
|
||||
if (rect) onOpen(spell, rect);
|
||||
}, [spell, onOpen]);
|
||||
|
||||
if (!spell.description) {
|
||||
return (
|
||||
<span>
|
||||
{spell.name}
|
||||
<UsesPerDay count={spell.usesPerDay} />
|
||||
</span>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<>
|
||||
<button
|
||||
ref={ref}
|
||||
type="button"
|
||||
onClick={handleClick}
|
||||
className="cursor-pointer text-foreground underline decoration-dotted underline-offset-2 hover:text-hover-neutral"
|
||||
>
|
||||
{spell.name}
|
||||
</button>
|
||||
<UsesPerDay count={spell.usesPerDay} />
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
interface SpellListLineProps {
|
||||
readonly label: string;
|
||||
readonly spells: readonly SpellReference[];
|
||||
readonly onOpen: (spell: SpellReference, rect: DOMRect) => void;
|
||||
}
|
||||
|
||||
function SpellListLine({
|
||||
label,
|
||||
spells,
|
||||
onOpen,
|
||||
}: Readonly<SpellListLineProps>) {
|
||||
return (
|
||||
<div className="pl-2">
|
||||
<span className="font-semibold">{label}:</span>{" "}
|
||||
{spells.map((spell, i) => (
|
||||
<span key={spell.slug ?? spell.name}>
|
||||
{i > 0 ? ", " : ""}
|
||||
<SpellLink spell={spell} onOpen={onOpen} />
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
interface EquipmentLinkProps {
|
||||
readonly item: EquipmentItem;
|
||||
readonly onOpen: (item: EquipmentItem, rect: DOMRect) => void;
|
||||
}
|
||||
|
||||
function EquipmentLink({ item, onOpen }: Readonly<EquipmentLinkProps>) {
|
||||
const ref = useRef<HTMLButtonElement>(null);
|
||||
const handleClick = useCallback(() => {
|
||||
if (!item.description) return;
|
||||
const rect = ref.current?.getBoundingClientRect();
|
||||
if (rect) onOpen(item, rect);
|
||||
}, [item, onOpen]);
|
||||
|
||||
if (!item.description) {
|
||||
return <span>{item.name}</span>;
|
||||
}
|
||||
|
||||
return (
|
||||
<button
|
||||
ref={ref}
|
||||
type="button"
|
||||
onClick={handleClick}
|
||||
className="cursor-pointer text-foreground underline decoration-dotted underline-offset-2 hover:text-hover-neutral"
|
||||
>
|
||||
{item.name}
|
||||
</button>
|
||||
);
|
||||
}
|
||||
|
||||
export function Pf2eStatBlock({ creature }: Readonly<Pf2eStatBlockProps>) {
|
||||
const [openSpell, setOpenSpell] = useState<{
|
||||
spell: SpellReference;
|
||||
rect: DOMRect;
|
||||
} | null>(null);
|
||||
const handleOpenSpell = useCallback(
|
||||
(spell: SpellReference, rect: DOMRect) => setOpenSpell({ spell, rect }),
|
||||
[],
|
||||
);
|
||||
const handleCloseSpell = useCallback(() => setOpenSpell(null), []);
|
||||
const [openEquipment, setOpenEquipment] = useState<{
|
||||
item: EquipmentItem;
|
||||
rect: DOMRect;
|
||||
} | null>(null);
|
||||
const handleOpenEquipment = useCallback(
|
||||
(item: EquipmentItem, rect: DOMRect) => setOpenEquipment({ item, rect }),
|
||||
[],
|
||||
);
|
||||
const handleCloseEquipment = useCallback(() => setOpenEquipment(null), []);
|
||||
|
||||
const rk = recallKnowledge(creature.level, creature.traits);
|
||||
|
||||
const abilityEntries = [
|
||||
{ label: "Str", mod: creature.abilityMods.str },
|
||||
{ label: "Dex", mod: creature.abilityMods.dex },
|
||||
@@ -69,6 +192,12 @@ export function Pf2eStatBlock({ creature }: Readonly<Pf2eStatBlockProps>) {
|
||||
<p className="mt-1 text-muted-foreground text-xs">
|
||||
{creature.sourceDisplayName}
|
||||
</p>
|
||||
{rk && (
|
||||
<p className="mt-1 text-sm">
|
||||
<span className="font-semibold">Recall Knowledge</span> DC {rk.dc}{" "}
|
||||
• {capitalize(rk.type)} ({rk.skills.join("/")})
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
|
||||
<SectionDivider />
|
||||
@@ -78,7 +207,9 @@ export function Pf2eStatBlock({ creature }: Readonly<Pf2eStatBlockProps>) {
|
||||
<div>
|
||||
<span className="font-semibold">Perception</span>{" "}
|
||||
{formatInitiativeModifier(creature.perception)}
|
||||
{creature.senses ? `; ${creature.senses}` : ""}
|
||||
{creature.senses || creature.perceptionDetails
|
||||
? `; ${[creature.senses, creature.perceptionDetails].filter(Boolean).join(", ")}`
|
||||
: ""}
|
||||
</div>
|
||||
<PropertyLine label="Languages" value={creature.languages} />
|
||||
<PropertyLine label="Skills" value={creature.skills} />
|
||||
@@ -152,23 +283,51 @@ export function Pf2eStatBlock({ creature }: Readonly<Pf2eStatBlockProps>) {
|
||||
{sc.headerText}
|
||||
</div>
|
||||
{sc.daily?.map((d) => (
|
||||
<div key={d.uses} className="pl-2">
|
||||
<span className="font-semibold">
|
||||
{d.uses === 0 ? "Cantrips" : `Rank ${d.uses}`}:
|
||||
</span>{" "}
|
||||
{d.spells.join(", ")}
|
||||
</div>
|
||||
<SpellListLine
|
||||
key={d.uses}
|
||||
label={d.uses === 0 ? "Cantrips" : `Rank ${d.uses}`}
|
||||
spells={d.spells}
|
||||
onOpen={handleOpenSpell}
|
||||
/>
|
||||
))}
|
||||
{sc.atWill && sc.atWill.length > 0 && (
|
||||
<div className="pl-2">
|
||||
<span className="font-semibold">Cantrips:</span>{" "}
|
||||
{sc.atWill.join(", ")}
|
||||
</div>
|
||||
<SpellListLine
|
||||
label="Cantrips"
|
||||
spells={sc.atWill}
|
||||
onOpen={handleOpenSpell}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</>
|
||||
)}
|
||||
{creature.equipment && creature.equipment.length > 0 && (
|
||||
<>
|
||||
<SectionDivider />
|
||||
<h3 className="font-bold text-base text-stat-heading">Equipment</h3>
|
||||
<div className="space-y-1 text-sm">
|
||||
{creature.equipment.map((item) => (
|
||||
<div key={item.name}>
|
||||
<EquipmentLink item={item} onOpen={handleOpenEquipment} />
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
{openSpell ? (
|
||||
<SpellDetailPopover
|
||||
spell={openSpell.spell}
|
||||
anchorRect={openSpell.rect}
|
||||
onClose={handleCloseSpell}
|
||||
/>
|
||||
) : null}
|
||||
{openEquipment ? (
|
||||
<EquipmentDetailPopover
|
||||
item={openEquipment.item}
|
||||
anchorRect={openEquipment.rect}
|
||||
onClose={handleCloseEquipment}
|
||||
/>
|
||||
) : null}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
20
apps/web/src/components/rich-description.tsx
Normal file
20
apps/web/src/components/rich-description.tsx
Normal file
@@ -0,0 +1,20 @@
|
||||
import { cn } from "../lib/utils.js";
|
||||
|
||||
/**
|
||||
* Renders text containing safe HTML formatting tags (strong, em, ul, ol, li)
|
||||
* preserved by the stripFoundryTags pipeline. All other HTML is already
|
||||
* stripped before reaching this component.
|
||||
*/
|
||||
export function RichDescription({
|
||||
text,
|
||||
className,
|
||||
}: Readonly<{ text: string; className?: string }>) {
|
||||
const props = {
|
||||
className: cn(
|
||||
"[&_ol]:list-decimal [&_ol]:pl-4 [&_ul]:list-disc [&_ul]:pl-4",
|
||||
className,
|
||||
),
|
||||
dangerouslySetInnerHTML: { __html: text },
|
||||
};
|
||||
return <div {...props} />;
|
||||
}
|
||||
@@ -8,7 +8,7 @@ import { Input } from "./ui/input.js";
|
||||
|
||||
interface SourceFetchPromptProps {
|
||||
sourceCode: string;
|
||||
onSourceLoaded: () => void;
|
||||
onSourceLoaded: (skippedNames: string[]) => void;
|
||||
}
|
||||
|
||||
export function SourceFetchPrompt({
|
||||
@@ -32,8 +32,9 @@ export function SourceFetchPrompt({
|
||||
setStatus("fetching");
|
||||
setError("");
|
||||
try {
|
||||
await fetchAndCacheSource(sourceCode, url);
|
||||
onSourceLoaded();
|
||||
const { skippedNames } = await fetchAndCacheSource(sourceCode, url);
|
||||
setStatus("idle");
|
||||
onSourceLoaded(skippedNames);
|
||||
} catch (e) {
|
||||
setStatus("error");
|
||||
setError(e instanceof Error ? e.message : "Failed to fetch source data");
|
||||
@@ -51,7 +52,7 @@ export function SourceFetchPrompt({
|
||||
const text = await file.text();
|
||||
const json = JSON.parse(text);
|
||||
await uploadAndCacheSource(sourceCode, json);
|
||||
onSourceLoaded();
|
||||
onSourceLoaded([]);
|
||||
} catch (err) {
|
||||
setStatus("error");
|
||||
setError(
|
||||
|
||||
178
apps/web/src/components/spell-detail-popover.tsx
Normal file
178
apps/web/src/components/spell-detail-popover.tsx
Normal file
@@ -0,0 +1,178 @@
|
||||
import type { ActivityCost, SpellReference } from "@initiative/domain";
|
||||
import { DetailPopover } from "./detail-popover.js";
|
||||
import { RichDescription } from "./rich-description.js";
|
||||
import { ActivityIcon } from "./stat-block-parts.js";
|
||||
|
||||
interface SpellDetailPopoverProps {
|
||||
readonly spell: SpellReference;
|
||||
readonly anchorRect: DOMRect;
|
||||
readonly onClose: () => void;
|
||||
}
|
||||
|
||||
const RANK_LABELS = [
|
||||
"Cantrip",
|
||||
"1st",
|
||||
"2nd",
|
||||
"3rd",
|
||||
"4th",
|
||||
"5th",
|
||||
"6th",
|
||||
"7th",
|
||||
"8th",
|
||||
"9th",
|
||||
"10th",
|
||||
];
|
||||
|
||||
function formatRank(rank: number | undefined): string {
|
||||
if (rank === undefined) return "";
|
||||
return RANK_LABELS[rank] ?? `Rank ${rank}`;
|
||||
}
|
||||
|
||||
function parseActionCost(cost: string): ActivityCost | null {
|
||||
if (cost === "free") return { number: 1, unit: "free" };
|
||||
if (cost === "reaction") return { number: 1, unit: "reaction" };
|
||||
const n = Number(cost);
|
||||
if (n >= 1 && n <= 3) return { number: n, unit: "action" };
|
||||
return null;
|
||||
}
|
||||
|
||||
function SpellActionCost({ cost }: Readonly<{ cost: string | undefined }>) {
|
||||
if (!cost) return null;
|
||||
const activity = parseActionCost(cost);
|
||||
if (activity) {
|
||||
return (
|
||||
<span className="shrink-0 text-lg">
|
||||
<ActivityIcon activity={activity} />
|
||||
</span>
|
||||
);
|
||||
}
|
||||
return <span className="shrink-0 text-muted-foreground text-xs">{cost}</span>;
|
||||
}
|
||||
|
||||
function SpellHeader({ spell }: Readonly<{ spell: SpellReference }>) {
|
||||
return (
|
||||
<div className="flex items-center justify-between gap-2">
|
||||
<h3 className="font-bold text-lg text-stat-heading">{spell.name}</h3>
|
||||
<SpellActionCost cost={spell.actionCost} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function SpellTraits({ traits }: Readonly<{ traits: readonly string[] }>) {
|
||||
if (traits.length === 0) return null;
|
||||
return (
|
||||
<div className="flex flex-wrap gap-1">
|
||||
{traits.map((t) => (
|
||||
<span
|
||||
key={t}
|
||||
className="rounded border border-border bg-card px-1.5 py-0.5 text-foreground text-xs"
|
||||
>
|
||||
{t}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function LabeledValue({
|
||||
label,
|
||||
value,
|
||||
}: Readonly<{ label: string; value: string }>) {
|
||||
return (
|
||||
<>
|
||||
<span className="font-semibold">{label}</span> {value}
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
function SpellRangeLine({ spell }: Readonly<{ spell: SpellReference }>) {
|
||||
const items: { label: string; value: string }[] = [];
|
||||
if (spell.range) items.push({ label: "Range", value: spell.range });
|
||||
if (spell.target) items.push({ label: "Target", value: spell.target });
|
||||
if (spell.area) items.push({ label: "Area", value: spell.area });
|
||||
|
||||
if (items.length === 0) return null;
|
||||
return (
|
||||
<div>
|
||||
{items.map((item, i) => (
|
||||
<span key={item.label}>
|
||||
{i > 0 ? "; " : ""}
|
||||
<LabeledValue label={item.label} value={item.value} />
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function SpellMeta({ spell }: Readonly<{ spell: SpellReference }>) {
|
||||
const hasTraditions =
|
||||
spell.traditions !== undefined && spell.traditions.length > 0;
|
||||
return (
|
||||
<div className="space-y-0.5 text-xs">
|
||||
{spell.rank === undefined ? null : (
|
||||
<div>
|
||||
<span className="font-semibold">{formatRank(spell.rank)}</span>
|
||||
{hasTraditions ? (
|
||||
<span className="text-muted-foreground">
|
||||
{" "}
|
||||
({spell.traditions?.join(", ")})
|
||||
</span>
|
||||
) : null}
|
||||
</div>
|
||||
)}
|
||||
<SpellRangeLine spell={spell} />
|
||||
{spell.duration ? (
|
||||
<div>
|
||||
<LabeledValue label="Duration" value={spell.duration} />
|
||||
</div>
|
||||
) : null}
|
||||
{spell.defense ? (
|
||||
<div>
|
||||
<LabeledValue label="Defense" value={spell.defense} />
|
||||
</div>
|
||||
) : null}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function SpellDetailContent({ spell }: Readonly<{ spell: SpellReference }>) {
|
||||
return (
|
||||
<div className="space-y-2 text-sm">
|
||||
<SpellHeader spell={spell} />
|
||||
<SpellTraits traits={spell.traits ?? []} />
|
||||
<SpellMeta spell={spell} />
|
||||
{spell.description ? (
|
||||
<RichDescription
|
||||
text={spell.description}
|
||||
className="whitespace-pre-line text-foreground"
|
||||
/>
|
||||
) : (
|
||||
<p className="text-muted-foreground italic">
|
||||
No description available.
|
||||
</p>
|
||||
)}
|
||||
{spell.heightening ? (
|
||||
<RichDescription
|
||||
text={spell.heightening}
|
||||
className="whitespace-pre-line text-foreground text-xs"
|
||||
/>
|
||||
) : null}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function SpellDetailPopover({
|
||||
spell,
|
||||
anchorRect,
|
||||
onClose,
|
||||
}: Readonly<SpellDetailPopoverProps>) {
|
||||
return (
|
||||
<DetailPopover
|
||||
anchorRect={anchorRect}
|
||||
onClose={onClose}
|
||||
ariaLabel={`Spell details: ${spell.name}`}
|
||||
>
|
||||
<SpellDetailContent spell={spell} />
|
||||
</DetailPopover>
|
||||
);
|
||||
}
|
||||
@@ -11,6 +11,7 @@ import { DndStatBlock } from "./dnd-stat-block.js";
|
||||
import { Pf2eStatBlock } from "./pf2e-stat-block.js";
|
||||
import { SourceFetchPrompt } from "./source-fetch-prompt.js";
|
||||
import { SourceManager } from "./source-manager.js";
|
||||
import { Toast } from "./toast.js";
|
||||
import { Button } from "./ui/button.js";
|
||||
|
||||
interface StatBlockPanelProps {
|
||||
@@ -241,7 +242,6 @@ export function StatBlockPanel({
|
||||
panelRole,
|
||||
side,
|
||||
}: Readonly<StatBlockPanelProps>) {
|
||||
const { isSourceCached } = useBestiaryContext();
|
||||
const {
|
||||
creatureId,
|
||||
creature,
|
||||
@@ -260,6 +260,7 @@ export function StatBlockPanel({
|
||||
);
|
||||
const [needsFetch, setNeedsFetch] = useState(false);
|
||||
const [checkingCache, setCheckingCache] = useState(false);
|
||||
const [skippedToast, setSkippedToast] = useState<string | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
const mq = globalThis.matchMedia("(min-width: 1024px)");
|
||||
@@ -280,19 +281,23 @@ export function StatBlockPanel({
|
||||
return;
|
||||
}
|
||||
|
||||
setCheckingCache(true);
|
||||
void isSourceCached(sourceCode).then((cached) => {
|
||||
setNeedsFetch(!cached);
|
||||
// Show fetch prompt both when source is uncached AND when the source is
|
||||
// cached but this specific creature is missing (e.g. skipped by ad blocker).
|
||||
setNeedsFetch(true);
|
||||
setCheckingCache(false);
|
||||
});
|
||||
}, [creatureId, creature, isSourceCached]);
|
||||
}, [creatureId, creature]);
|
||||
|
||||
if (!creatureId && !bulkImportMode && !sourceManagerMode) return null;
|
||||
|
||||
const sourceCode = creatureId ? extractSourceCode(creatureId) : "";
|
||||
|
||||
const handleSourceLoaded = () => {
|
||||
setNeedsFetch(false);
|
||||
const handleSourceLoaded = (skippedNames: string[]) => {
|
||||
if (skippedNames.length > 0) {
|
||||
const names = skippedNames.join(", ");
|
||||
setSkippedToast(
|
||||
`${skippedNames.length} creature(s) skipped (ad blocker?): ${names}`,
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
const renderContent = () => {
|
||||
@@ -338,8 +343,13 @@ export function StatBlockPanel({
|
||||
else if (bulkImportMode) fallbackName = "Import All Sources";
|
||||
const creatureName = creature?.name ?? fallbackName;
|
||||
|
||||
const toast = skippedToast ? (
|
||||
<Toast message={skippedToast} onDismiss={() => setSkippedToast(null)} />
|
||||
) : null;
|
||||
|
||||
if (isDesktop) {
|
||||
return (
|
||||
<>
|
||||
<DesktopPanel
|
||||
isCollapsed={isCollapsed}
|
||||
side={side}
|
||||
@@ -352,10 +362,17 @@ export function StatBlockPanel({
|
||||
>
|
||||
{renderContent()}
|
||||
</DesktopPanel>
|
||||
{toast}
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
if (panelRole === "pinned" || isCollapsed) return null;
|
||||
|
||||
return <MobileDrawer onDismiss={onDismiss}>{renderContent()}</MobileDrawer>;
|
||||
return (
|
||||
<>
|
||||
<MobileDrawer onDismiss={onDismiss}>{renderContent()}</MobileDrawer>
|
||||
{toast}
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -3,6 +3,7 @@ import type {
|
||||
TraitBlock,
|
||||
TraitSegment,
|
||||
} from "@initiative/domain";
|
||||
import { RichDescription } from "./rich-description.js";
|
||||
|
||||
export function PropertyLine({
|
||||
label,
|
||||
@@ -39,20 +40,22 @@ function TraitSegments({
|
||||
{segments.map((seg, i) => {
|
||||
if (seg.type === "text") {
|
||||
return (
|
||||
<span key={segmentKey(seg)}>
|
||||
{i === 0 ? ` ${seg.value}` : seg.value}
|
||||
</span>
|
||||
<RichDescription
|
||||
key={segmentKey(seg)}
|
||||
text={i === 0 ? ` ${seg.value}` : seg.value}
|
||||
className="inline whitespace-pre-line"
|
||||
/>
|
||||
);
|
||||
}
|
||||
return (
|
||||
<div key={segmentKey(seg)} className="mt-1 space-y-0.5">
|
||||
{seg.items.map((item) => (
|
||||
<p key={item.label ?? item.text}>
|
||||
<div key={item.label ?? item.text}>
|
||||
{item.label != null && (
|
||||
<span className="font-semibold">{item.label}. </span>
|
||||
)}
|
||||
{item.text}
|
||||
</p>
|
||||
<RichDescription text={item.text} className="inline" />
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
@@ -71,7 +74,9 @@ const FREE_ACTION_CHEVRON = "M48 27 L71 50 L48 73 Z";
|
||||
const REACTION_ARROW =
|
||||
"M75 15 A42 42 0 1 0 85 55 L72 55 A30 30 0 1 1 65 25 L65 40 L92 20 L65 0 L65 15 Z";
|
||||
|
||||
function ActivityIcon({ activity }: Readonly<{ activity: ActivityCost }>) {
|
||||
export function ActivityIcon({
|
||||
activity,
|
||||
}: Readonly<{ activity: ActivityCost }>) {
|
||||
const cls = "inline-block h-[1em] align-[-0.1em]";
|
||||
if (activity.unit === "free") {
|
||||
return (
|
||||
@@ -136,6 +141,7 @@ export function TraitEntry({ trait }: Readonly<{ trait: TraitBlock }>) {
|
||||
</>
|
||||
) : null}
|
||||
</span>
|
||||
{trait.frequency ? ` (${trait.frequency})` : null}
|
||||
{trait.trigger ? (
|
||||
<>
|
||||
{" "}
|
||||
|
||||
@@ -28,7 +28,10 @@ interface BestiaryHook {
|
||||
getCreature: (id: CreatureId) => AnyCreature | undefined;
|
||||
isLoaded: boolean;
|
||||
isSourceCached: (sourceCode: string) => Promise<boolean>;
|
||||
fetchAndCacheSource: (sourceCode: string, url: string) => Promise<void>;
|
||||
fetchAndCacheSource: (
|
||||
sourceCode: string,
|
||||
url: string,
|
||||
) => Promise<{ skippedNames: string[] }>;
|
||||
uploadAndCacheSource: (
|
||||
sourceCode: string,
|
||||
jsonData: unknown,
|
||||
@@ -36,6 +39,108 @@ interface BestiaryHook {
|
||||
refreshCache: () => Promise<void>;
|
||||
}
|
||||
|
||||
interface BatchResult {
|
||||
readonly responses: unknown[];
|
||||
readonly failed: string[];
|
||||
}
|
||||
|
||||
async function fetchJson(url: string, path: string): Promise<unknown> {
|
||||
const response = await fetch(url);
|
||||
if (!response.ok) {
|
||||
throw new Error(
|
||||
`Failed to fetch ${path}: ${response.status} ${response.statusText}`,
|
||||
);
|
||||
}
|
||||
return response.json();
|
||||
}
|
||||
|
||||
async function fetchWithRetry(
|
||||
url: string,
|
||||
path: string,
|
||||
retries = 2,
|
||||
): Promise<unknown> {
|
||||
try {
|
||||
return await fetchJson(url, path);
|
||||
} catch (error) {
|
||||
if (retries <= 0) throw error;
|
||||
await new Promise<void>((r) => setTimeout(r, 500));
|
||||
return fetchWithRetry(url, path, retries - 1);
|
||||
}
|
||||
}
|
||||
|
||||
async function fetchBatch(
|
||||
baseUrl: string,
|
||||
paths: string[],
|
||||
): Promise<BatchResult> {
|
||||
const settled = await Promise.allSettled(
|
||||
paths.map((path) => fetchWithRetry(`${baseUrl}${path}`, path)),
|
||||
);
|
||||
const responses: unknown[] = [];
|
||||
const failed: string[] = [];
|
||||
for (let i = 0; i < settled.length; i++) {
|
||||
const result = settled[i];
|
||||
if (result.status === "fulfilled") {
|
||||
responses.push(result.value);
|
||||
} else {
|
||||
failed.push(paths[i]);
|
||||
}
|
||||
}
|
||||
return { responses, failed };
|
||||
}
|
||||
|
||||
async function fetchInBatches(
|
||||
paths: string[],
|
||||
baseUrl: string,
|
||||
concurrency: number,
|
||||
): Promise<BatchResult> {
|
||||
const batches: string[][] = [];
|
||||
for (let i = 0; i < paths.length; i += concurrency) {
|
||||
batches.push(paths.slice(i, i + concurrency));
|
||||
}
|
||||
const accumulated = await batches.reduce<Promise<BatchResult>>(
|
||||
async (prev, batch) => {
|
||||
const acc = await prev;
|
||||
const result = await fetchBatch(baseUrl, batch);
|
||||
return {
|
||||
responses: [...acc.responses, ...result.responses],
|
||||
failed: [...acc.failed, ...result.failed],
|
||||
};
|
||||
},
|
||||
Promise.resolve({ responses: [], failed: [] }),
|
||||
);
|
||||
return accumulated;
|
||||
}
|
||||
|
||||
interface Pf2eFetchResult {
|
||||
creatures: AnyCreature[];
|
||||
skippedNames: string[];
|
||||
}
|
||||
|
||||
async function fetchPf2eSource(
|
||||
paths: string[],
|
||||
url: string,
|
||||
sourceCode: string,
|
||||
displayName: string,
|
||||
resolveNames: (failedPaths: string[]) => Map<string, string>,
|
||||
): Promise<Pf2eFetchResult> {
|
||||
const baseUrl = url.endsWith("/") ? url : `${url}/`;
|
||||
const { responses, failed } = await fetchInBatches(paths, baseUrl, 6);
|
||||
if (responses.length === 0) {
|
||||
throw new Error(
|
||||
`Failed to fetch any creatures (${failed.length} failed). This may be caused by an ad blocker — try disabling it for this site or use file upload instead.`,
|
||||
);
|
||||
}
|
||||
const nameMap = failed.length > 0 ? resolveNames(failed) : new Map();
|
||||
const skippedNames = failed.map((p) => nameMap.get(p) ?? p);
|
||||
if (skippedNames.length > 0) {
|
||||
console.warn("Skipped creatures (ad blocker?):", skippedNames);
|
||||
}
|
||||
return {
|
||||
creatures: normalizeFoundryCreatures(responses, sourceCode, displayName),
|
||||
skippedNames,
|
||||
};
|
||||
}
|
||||
|
||||
export function useBestiary(): BestiaryHook {
|
||||
const { bestiaryCache, bestiaryIndex, pf2eBestiaryIndex } = useAdapters();
|
||||
const { edition } = useRulesEditionContext();
|
||||
@@ -108,30 +213,25 @@ export function useBestiary(): BestiaryHook {
|
||||
);
|
||||
|
||||
const fetchAndCacheSource = useCallback(
|
||||
async (sourceCode: string, url: string): Promise<void> => {
|
||||
async (
|
||||
sourceCode: string,
|
||||
url: string,
|
||||
): Promise<{ skippedNames: string[] }> => {
|
||||
let creatures: AnyCreature[];
|
||||
let skippedNames: string[] = [];
|
||||
|
||||
if (edition === "pf2e") {
|
||||
// PF2e: url is a base URL; fetch each creature file in parallel
|
||||
const paths = pf2eBestiaryIndex.getCreaturePathsForSource(sourceCode);
|
||||
const baseUrl = url.endsWith("/") ? url : `${url}/`;
|
||||
const responses = await Promise.all(
|
||||
paths.map(async (path) => {
|
||||
const response = await fetch(`${baseUrl}${path}`);
|
||||
if (!response.ok) {
|
||||
throw new Error(
|
||||
`Failed to fetch ${path}: ${response.status} ${response.statusText}`,
|
||||
);
|
||||
}
|
||||
return response.json();
|
||||
}),
|
||||
);
|
||||
const displayName = pf2eBestiaryIndex.getSourceDisplayName(sourceCode);
|
||||
creatures = normalizeFoundryCreatures(
|
||||
responses,
|
||||
const result = await fetchPf2eSource(
|
||||
paths,
|
||||
url,
|
||||
sourceCode,
|
||||
displayName,
|
||||
pf2eBestiaryIndex.getCreatureNamesByPaths,
|
||||
);
|
||||
creatures = result.creatures;
|
||||
skippedNames = result.skippedNames;
|
||||
} else {
|
||||
const response = await fetch(url);
|
||||
if (!response.ok) {
|
||||
@@ -160,6 +260,7 @@ export function useBestiary(): BestiaryHook {
|
||||
}
|
||||
return next;
|
||||
});
|
||||
return { skippedNames };
|
||||
},
|
||||
[bestiaryCache, bestiaryIndex, pf2eBestiaryIndex, edition, system],
|
||||
);
|
||||
|
||||
@@ -22,7 +22,10 @@ interface BulkImportHook {
|
||||
state: BulkImportState;
|
||||
startImport: (
|
||||
baseUrl: string,
|
||||
fetchAndCacheSource: (sourceCode: string, url: string) => Promise<void>,
|
||||
fetchAndCacheSource: (
|
||||
sourceCode: string,
|
||||
url: string,
|
||||
) => Promise<{ skippedNames: string[] }>,
|
||||
isSourceCached: (sourceCode: string) => Promise<boolean>,
|
||||
refreshCache: () => Promise<void>,
|
||||
) => void;
|
||||
@@ -39,7 +42,10 @@ export function useBulkImport(): BulkImportHook {
|
||||
const startImport = useCallback(
|
||||
(
|
||||
baseUrl: string,
|
||||
fetchAndCacheSource: (sourceCode: string, url: string) => Promise<void>,
|
||||
fetchAndCacheSource: (
|
||||
sourceCode: string,
|
||||
url: string,
|
||||
) => Promise<{ skippedNames: string[] }>,
|
||||
isSourceCached: (sourceCode: string) => Promise<boolean>,
|
||||
refreshCache: () => Promise<void>,
|
||||
) => {
|
||||
|
||||
@@ -421,7 +421,10 @@ function dispatchEncounterAction(
|
||||
export function useEncounter() {
|
||||
const { encounterPersistence, undoRedoPersistence } = useAdapters();
|
||||
const [state, dispatch] = useReducer(encounterReducer, null, () =>
|
||||
initializeState(encounterPersistence.load, undoRedoPersistence.load),
|
||||
initializeState(
|
||||
() => encounterPersistence.load(),
|
||||
() => undoRedoPersistence.load(),
|
||||
),
|
||||
);
|
||||
const { encounter, undoRedoState, events } = state;
|
||||
|
||||
|
||||
@@ -70,3 +70,72 @@ export function useSwipeToDismiss(onDismiss: () => void) {
|
||||
handlers: { onTouchStart, onTouchMove, onTouchEnd },
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Vertical (down-only) variant for dismissing bottom sheets via swipe-down.
|
||||
* Mirrors `useSwipeToDismiss` but locks to vertical direction and tracks
|
||||
* the sheet height instead of width.
|
||||
*/
|
||||
export function useSwipeToDismissDown(onDismiss: () => void) {
|
||||
const [swipe, setSwipe] = useState<SwipeState>({
|
||||
offsetX: 0,
|
||||
isSwiping: false,
|
||||
});
|
||||
const startX = useRef(0);
|
||||
const startY = useRef(0);
|
||||
const startTime = useRef(0);
|
||||
const sheetHeight = useRef(0);
|
||||
const directionLocked = useRef<"horizontal" | "vertical" | null>(null);
|
||||
|
||||
const onTouchStart = useCallback((e: React.TouchEvent) => {
|
||||
const touch = e.touches[0];
|
||||
startX.current = touch.clientX;
|
||||
startY.current = touch.clientY;
|
||||
startTime.current = Date.now();
|
||||
directionLocked.current = null;
|
||||
const el = e.currentTarget as HTMLElement;
|
||||
sheetHeight.current = el.getBoundingClientRect().height;
|
||||
}, []);
|
||||
|
||||
const onTouchMove = useCallback((e: React.TouchEvent) => {
|
||||
const touch = e.touches[0];
|
||||
const dx = touch.clientX - startX.current;
|
||||
const dy = touch.clientY - startY.current;
|
||||
|
||||
if (!directionLocked.current) {
|
||||
if (Math.abs(dx) < 10 && Math.abs(dy) < 10) return;
|
||||
directionLocked.current =
|
||||
Math.abs(dy) > Math.abs(dx) ? "vertical" : "horizontal";
|
||||
}
|
||||
|
||||
if (directionLocked.current === "horizontal") return;
|
||||
|
||||
const clampedY = Math.max(0, dy);
|
||||
// `offsetX` is reused as the vertical offset to keep SwipeState shared.
|
||||
setSwipe({ offsetX: clampedY, isSwiping: true });
|
||||
}, []);
|
||||
|
||||
const onTouchEnd = useCallback(() => {
|
||||
if (directionLocked.current !== "vertical") {
|
||||
setSwipe({ offsetX: 0, isSwiping: false });
|
||||
return;
|
||||
}
|
||||
|
||||
const elapsed = (Date.now() - startTime.current) / 1000;
|
||||
const velocity = swipe.offsetX / elapsed / sheetHeight.current;
|
||||
const ratio =
|
||||
sheetHeight.current > 0 ? swipe.offsetX / sheetHeight.current : 0;
|
||||
|
||||
if (ratio > DISMISS_THRESHOLD || velocity > VELOCITY_THRESHOLD) {
|
||||
onDismiss();
|
||||
}
|
||||
|
||||
setSwipe({ offsetX: 0, isSwiping: false });
|
||||
}, [swipe.offsetX, onDismiss]);
|
||||
|
||||
return {
|
||||
offsetY: swipe.offsetX,
|
||||
isSwiping: swipe.isSwiping,
|
||||
handlers: { onTouchStart, onTouchMove, onTouchEnd },
|
||||
};
|
||||
}
|
||||
|
||||
@@ -103,6 +103,19 @@
|
||||
animation: slide-in-right 200ms ease-out;
|
||||
}
|
||||
|
||||
@keyframes slide-in-bottom {
|
||||
from {
|
||||
transform: translateY(100%);
|
||||
}
|
||||
to {
|
||||
transform: translateY(0);
|
||||
}
|
||||
}
|
||||
|
||||
@utility animate-slide-in-bottom {
|
||||
animation: slide-in-bottom 200ms ease-out;
|
||||
}
|
||||
|
||||
@keyframes confirm-pulse {
|
||||
0% {
|
||||
scale: 1;
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
"knip": "knip",
|
||||
"jscpd": "jscpd",
|
||||
"jsinspect": "jsinspect -c .jsinspectrc apps/web/src packages/domain/src packages/application/src",
|
||||
"oxlint": "oxlint --tsconfig apps/web/tsconfig.json --type-aware --deny warnings",
|
||||
"oxlint": "oxlint --tsconfig apps/web/tsconfig.json --type-aware --deny-warnings",
|
||||
"check:ignores": "node scripts/check-lint-ignores.mjs",
|
||||
"check:classnames": "node scripts/check-cn-classnames.mjs",
|
||||
"check:props": "node scripts/check-component-props.mjs",
|
||||
|
||||
@@ -47,8 +47,8 @@ describe("getConditionDescription", () => {
|
||||
(d.systems.includes("5e") && d.systems.includes("5.5e")),
|
||||
);
|
||||
for (const def of sharedDndConditions) {
|
||||
expect(def.description, `${def.id} missing description`).toBeTruthy();
|
||||
expect(def.description5e, `${def.id} missing description5e`).toBeTruthy();
|
||||
expect(def.description).toBeTruthy();
|
||||
expect(def.description5e).toBeTruthy();
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
99
packages/domain/src/__tests__/recall-knowledge.test.ts
Normal file
99
packages/domain/src/__tests__/recall-knowledge.test.ts
Normal file
@@ -0,0 +1,99 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { recallKnowledge } from "../recall-knowledge.js";
|
||||
|
||||
describe("recallKnowledge", () => {
|
||||
it("returns null when no type trait is recognized", () => {
|
||||
expect(recallKnowledge(5, ["small", "goblin"])).toBeNull();
|
||||
});
|
||||
|
||||
it("calculates DC for a common creature from the DC-by-level table", () => {
|
||||
const result = recallKnowledge(5, ["humanoid"]);
|
||||
expect(result).toEqual({ dc: 20, type: "humanoid", skills: ["Society"] });
|
||||
});
|
||||
|
||||
it("calculates DC for level -1", () => {
|
||||
const result = recallKnowledge(-1, ["humanoid"]);
|
||||
expect(result).toEqual({ dc: 13, type: "humanoid", skills: ["Society"] });
|
||||
});
|
||||
|
||||
it("calculates DC for level 0", () => {
|
||||
const result = recallKnowledge(0, ["animal"]);
|
||||
expect(result).toEqual({ dc: 14, type: "animal", skills: ["Nature"] });
|
||||
});
|
||||
|
||||
it("calculates DC for level 25 (max table entry)", () => {
|
||||
const result = recallKnowledge(25, ["dragon"]);
|
||||
expect(result).toEqual({ dc: 50, type: "dragon", skills: ["Arcana"] });
|
||||
});
|
||||
|
||||
it("clamps DC for levels beyond the table", () => {
|
||||
const result = recallKnowledge(30, ["dragon"]);
|
||||
expect(result).toEqual({ dc: 50, type: "dragon", skills: ["Arcana"] });
|
||||
});
|
||||
|
||||
it("adjusts DC for uncommon rarity (+2)", () => {
|
||||
const result = recallKnowledge(5, ["uncommon", "medium", "undead"]);
|
||||
expect(result).toEqual({
|
||||
dc: 22,
|
||||
type: "undead",
|
||||
skills: ["Religion"],
|
||||
});
|
||||
});
|
||||
|
||||
it("adjusts DC for rare rarity (+5)", () => {
|
||||
const result = recallKnowledge(5, ["rare", "large", "dragon"]);
|
||||
expect(result).toEqual({ dc: 25, type: "dragon", skills: ["Arcana"] });
|
||||
});
|
||||
|
||||
it("adjusts DC for unique rarity (+10)", () => {
|
||||
const result = recallKnowledge(5, ["unique", "medium", "humanoid"]);
|
||||
expect(result).toEqual({
|
||||
dc: 30,
|
||||
type: "humanoid",
|
||||
skills: ["Society"],
|
||||
});
|
||||
});
|
||||
|
||||
it("returns multiple skills for beast type", () => {
|
||||
const result = recallKnowledge(3, ["beast"]);
|
||||
expect(result).toEqual({
|
||||
dc: 18,
|
||||
type: "beast",
|
||||
skills: ["Arcana", "Nature"],
|
||||
});
|
||||
});
|
||||
|
||||
it("returns multiple skills for construct type", () => {
|
||||
const result = recallKnowledge(1, ["construct"]);
|
||||
expect(result).toEqual({
|
||||
dc: 15,
|
||||
type: "construct",
|
||||
skills: ["Arcana", "Crafting"],
|
||||
});
|
||||
});
|
||||
|
||||
it("matches type traits case-insensitively", () => {
|
||||
const result = recallKnowledge(5, ["Humanoid"]);
|
||||
expect(result).toEqual({ dc: 20, type: "Humanoid", skills: ["Society"] });
|
||||
});
|
||||
|
||||
it("uses the first matching type trait when multiple are present", () => {
|
||||
const result = recallKnowledge(7, ["large", "monitor", "protean"]);
|
||||
expect(result).toEqual({
|
||||
dc: 23,
|
||||
type: "monitor",
|
||||
skills: ["Religion"],
|
||||
});
|
||||
});
|
||||
|
||||
it("preserves original trait casing in the returned type", () => {
|
||||
const result = recallKnowledge(1, ["Fey"]);
|
||||
expect(result?.type).toBe("Fey");
|
||||
});
|
||||
|
||||
it("ignores common rarity (no adjustment)", () => {
|
||||
// "common" is not included in traits by the normalization pipeline
|
||||
const result = recallKnowledge(5, ["medium", "humanoid"]);
|
||||
expect(result?.dc).toBe(20);
|
||||
});
|
||||
});
|
||||
@@ -1,3 +1,28 @@
|
||||
const DIGITS_ONLY = /^\d+$/;
|
||||
|
||||
function scanExisting(
|
||||
baseName: string,
|
||||
existingNames: readonly string[],
|
||||
): { exactMatches: number[]; maxNumber: number } {
|
||||
const exactMatches: number[] = [];
|
||||
let maxNumber = 0;
|
||||
const prefix = `${baseName} `;
|
||||
|
||||
for (let i = 0; i < existingNames.length; i++) {
|
||||
const name = existingNames[i];
|
||||
if (name === baseName) {
|
||||
exactMatches.push(i);
|
||||
} else if (name.startsWith(prefix)) {
|
||||
const suffix = name.slice(prefix.length);
|
||||
if (DIGITS_ONLY.test(suffix)) {
|
||||
const num = Number.parseInt(suffix, 10);
|
||||
if (num > maxNumber) maxNumber = num;
|
||||
}
|
||||
}
|
||||
}
|
||||
return { exactMatches, maxNumber };
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves a creature name against existing combatant names,
|
||||
* handling auto-numbering for duplicates.
|
||||
@@ -14,25 +39,7 @@ export function resolveCreatureName(
|
||||
newName: string;
|
||||
renames: ReadonlyArray<{ from: string; to: string }>;
|
||||
} {
|
||||
// Find exact matches and numbered matches (e.g., "Goblin 1", "Goblin 2")
|
||||
const exactMatches: number[] = [];
|
||||
let maxNumber = 0;
|
||||
|
||||
for (let i = 0; i < existingNames.length; i++) {
|
||||
const name = existingNames[i];
|
||||
if (name === baseName) {
|
||||
exactMatches.push(i);
|
||||
} else {
|
||||
const match = new RegExp(
|
||||
String.raw`^${escapeRegExp(baseName)} (\d+)$`,
|
||||
).exec(name);
|
||||
// biome-ignore lint/nursery/noUnnecessaryConditions: RegExp.exec() returns null on no match — false positive
|
||||
if (match) {
|
||||
const num = Number.parseInt(match[1], 10);
|
||||
if (num > maxNumber) maxNumber = num;
|
||||
}
|
||||
}
|
||||
}
|
||||
const { exactMatches, maxNumber } = scanExisting(baseName, existingNames);
|
||||
|
||||
// No conflict at all
|
||||
if (exactMatches.length === 0 && maxNumber === 0) {
|
||||
@@ -51,7 +58,3 @@ export function resolveCreatureName(
|
||||
const nextNumber = Math.max(maxNumber, exactMatches.length) + 1;
|
||||
return { newName: `${baseName} ${nextNumber}`, renames: [] };
|
||||
}
|
||||
|
||||
function escapeRegExp(s: string): string {
|
||||
return s.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`);
|
||||
}
|
||||
|
||||
@@ -23,6 +23,7 @@ export interface TraitBlock {
|
||||
readonly name: string;
|
||||
readonly activity?: ActivityCost;
|
||||
readonly trigger?: string;
|
||||
readonly frequency?: string;
|
||||
readonly segments: readonly TraitSegment[];
|
||||
}
|
||||
|
||||
@@ -31,16 +32,84 @@ export interface LegendaryBlock {
|
||||
readonly entries: readonly TraitBlock[];
|
||||
}
|
||||
|
||||
/**
|
||||
* A single spell entry within a creature's spellcasting block.
|
||||
*
|
||||
* `name` is always populated. All other fields are optional and are only
|
||||
* populated for PF2e creatures (sourced from embedded Foundry VTT spell items).
|
||||
* D&D 5e creatures populate only `name`.
|
||||
*/
|
||||
export interface SpellReference {
|
||||
readonly name: string;
|
||||
|
||||
/** Stable slug from Foundry VTT (e.g. "magic-missile"). PF2e only. */
|
||||
readonly slug?: string;
|
||||
|
||||
/** Plain-text description with Foundry enrichment tags stripped. */
|
||||
readonly description?: string;
|
||||
|
||||
/** Spell rank/level (0 = cantrip). */
|
||||
readonly rank?: number;
|
||||
|
||||
/** Trait slugs (e.g. ["concentrate", "manipulate", "force"]). */
|
||||
readonly traits?: readonly string[];
|
||||
|
||||
/** Tradition labels (e.g. ["arcane", "occult"]). */
|
||||
readonly traditions?: readonly string[];
|
||||
|
||||
/** Range (e.g. "30 feet", "touch"). */
|
||||
readonly range?: string;
|
||||
|
||||
/** Target (e.g. "1 creature"). */
|
||||
readonly target?: string;
|
||||
|
||||
/** Area (e.g. "20-foot burst"). */
|
||||
readonly area?: string;
|
||||
|
||||
/** Duration (e.g. "1 minute", "sustained up to 1 minute"). */
|
||||
readonly duration?: string;
|
||||
|
||||
/** Defense / save (e.g. "basic Reflex", "Will"). */
|
||||
readonly defense?: string;
|
||||
|
||||
/** Action cost. PF2e: number = action count, "reaction", "free", or
|
||||
* "1 minute" / "10 minutes" for cast time. */
|
||||
readonly actionCost?: string;
|
||||
|
||||
/**
|
||||
* Heightening rules text. May come from `system.heightening` (fixed
|
||||
* intervals) or `system.overlays` (variant casts). Plain text after
|
||||
* tag stripping.
|
||||
*/
|
||||
readonly heightening?: string;
|
||||
|
||||
/** Uses per day for "(×N)" rendering, when > 1. PF2e only. */
|
||||
readonly usesPerDay?: number;
|
||||
}
|
||||
|
||||
/** A carried equipment item on a PF2e creature (weapon, consumable, magic item, etc.). */
|
||||
export interface EquipmentItem {
|
||||
readonly name: string;
|
||||
readonly level: number;
|
||||
readonly category?: string;
|
||||
readonly traits?: readonly string[];
|
||||
readonly description?: string;
|
||||
/** For scrolls/wands: the embedded spell name. */
|
||||
readonly spellName?: string;
|
||||
/** For scrolls/wands: the embedded spell rank. */
|
||||
readonly spellRank?: number;
|
||||
}
|
||||
|
||||
export interface DailySpells {
|
||||
readonly uses: number;
|
||||
readonly each: boolean;
|
||||
readonly spells: readonly string[];
|
||||
readonly spells: readonly SpellReference[];
|
||||
}
|
||||
|
||||
export interface SpellcastingBlock {
|
||||
readonly name: string;
|
||||
readonly headerText: string;
|
||||
readonly atWill?: readonly string[];
|
||||
readonly atWill?: readonly SpellReference[];
|
||||
readonly daily?: readonly DailySpells[];
|
||||
readonly restLong?: readonly DailySpells[];
|
||||
}
|
||||
@@ -117,6 +186,7 @@ export interface Pf2eCreature {
|
||||
readonly level: number;
|
||||
readonly traits: readonly string[];
|
||||
readonly perception: number;
|
||||
readonly perceptionDetails?: string;
|
||||
readonly senses?: string;
|
||||
readonly languages?: string;
|
||||
readonly skills?: string;
|
||||
@@ -146,6 +216,7 @@ export interface Pf2eCreature {
|
||||
readonly abilitiesMid?: readonly TraitBlock[];
|
||||
readonly abilitiesBot?: readonly TraitBlock[];
|
||||
readonly spellcasting?: readonly SpellcastingBlock[];
|
||||
readonly equipment?: readonly EquipmentItem[];
|
||||
}
|
||||
|
||||
export type AnyCreature = Creature | Pf2eCreature;
|
||||
|
||||
@@ -33,12 +33,14 @@ export {
|
||||
type CreatureId,
|
||||
creatureId,
|
||||
type DailySpells,
|
||||
type EquipmentItem,
|
||||
type LegendaryBlock,
|
||||
type Pf2eBestiaryIndex,
|
||||
type Pf2eBestiaryIndexEntry,
|
||||
type Pf2eCreature,
|
||||
proficiencyBonus,
|
||||
type SpellcastingBlock,
|
||||
type SpellReference,
|
||||
type TraitBlock,
|
||||
type TraitListItem,
|
||||
type TraitSegment,
|
||||
@@ -107,6 +109,10 @@ export {
|
||||
VALID_PLAYER_COLORS,
|
||||
VALID_PLAYER_ICONS,
|
||||
} from "./player-character-types.js";
|
||||
export {
|
||||
type RecallKnowledge,
|
||||
recallKnowledge,
|
||||
} from "./recall-knowledge.js";
|
||||
export { rehydrateCombatant } from "./rehydrate-combatant.js";
|
||||
export { rehydratePlayerCharacter } from "./rehydrate-player-character.js";
|
||||
export {
|
||||
|
||||
118
packages/domain/src/recall-knowledge.ts
Normal file
118
packages/domain/src/recall-knowledge.ts
Normal file
@@ -0,0 +1,118 @@
|
||||
/**
|
||||
* PF2e Recall Knowledge DC calculation and type-to-skill mapping.
|
||||
*
|
||||
* DC is derived from creature level using the standard DC-by-level table
|
||||
* (Player Core / GM Core), adjusted for rarity.
|
||||
*/
|
||||
|
||||
/** Standard DC-by-level table from PF2e GM Core. Index = level + 1 (level -1 → index 0). */
|
||||
const DC_BY_LEVEL: readonly number[] = [
|
||||
13, // level -1
|
||||
14, // level 0
|
||||
15, // level 1
|
||||
16, // level 2
|
||||
18, // level 3
|
||||
19, // level 4
|
||||
20, // level 5
|
||||
22, // level 6
|
||||
23, // level 7
|
||||
24, // level 8
|
||||
26, // level 9
|
||||
27, // level 10
|
||||
28, // level 11
|
||||
30, // level 12
|
||||
31, // level 13
|
||||
32, // level 14
|
||||
34, // level 15
|
||||
35, // level 16
|
||||
36, // level 17
|
||||
38, // level 18
|
||||
39, // level 19
|
||||
40, // level 20
|
||||
42, // level 21
|
||||
44, // level 22
|
||||
46, // level 23
|
||||
48, // level 24
|
||||
50, // level 25
|
||||
];
|
||||
|
||||
const RARITY_ADJUSTMENT: Readonly<Record<string, number>> = {
|
||||
uncommon: 2,
|
||||
rare: 5,
|
||||
unique: 10,
|
||||
};
|
||||
|
||||
/**
|
||||
* Mapping from PF2e creature type traits to the skill(s) used for
|
||||
* Recall Knowledge. Types that map to multiple skills list all of them.
|
||||
*/
|
||||
const TYPE_TO_SKILLS: Readonly<Record<string, readonly string[]>> = {
|
||||
aberration: ["Occultism"],
|
||||
animal: ["Nature"],
|
||||
astral: ["Occultism"],
|
||||
beast: ["Arcana", "Nature"],
|
||||
celestial: ["Religion"],
|
||||
construct: ["Arcana", "Crafting"],
|
||||
dragon: ["Arcana"],
|
||||
dream: ["Occultism"],
|
||||
elemental: ["Arcana", "Nature"],
|
||||
ethereal: ["Occultism"],
|
||||
fey: ["Nature"],
|
||||
fiend: ["Religion"],
|
||||
fungus: ["Nature"],
|
||||
giant: ["Society"],
|
||||
humanoid: ["Society"],
|
||||
monitor: ["Religion"],
|
||||
ooze: ["Occultism"],
|
||||
plant: ["Nature"],
|
||||
undead: ["Religion"],
|
||||
};
|
||||
|
||||
export interface RecallKnowledge {
|
||||
readonly dc: number;
|
||||
readonly type: string;
|
||||
readonly skills: readonly string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate Recall Knowledge DC, type, and skill(s) for a PF2e creature.
|
||||
*
|
||||
* Returns `null` when no recognized type trait is found in the creature's
|
||||
* traits array, indicating the Recall Knowledge line should be omitted.
|
||||
*/
|
||||
export function recallKnowledge(
|
||||
level: number,
|
||||
traits: readonly string[],
|
||||
): RecallKnowledge | null {
|
||||
// Find the first type trait that maps to a skill
|
||||
let matchedType: string | undefined;
|
||||
let skills: readonly string[] | undefined;
|
||||
|
||||
for (const trait of traits) {
|
||||
const lower = trait.toLowerCase();
|
||||
const mapped = TYPE_TO_SKILLS[lower];
|
||||
if (mapped) {
|
||||
matchedType = trait;
|
||||
skills = mapped;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!matchedType || !skills) return null;
|
||||
|
||||
// Calculate DC from level
|
||||
const clampedIndex = Math.max(0, Math.min(level + 1, DC_BY_LEVEL.length - 1));
|
||||
let dc = DC_BY_LEVEL[clampedIndex];
|
||||
|
||||
// Apply rarity adjustment (rarity traits are included in the traits array
|
||||
// for non-common creatures by the normalization pipeline)
|
||||
for (const trait of traits) {
|
||||
const adjustment = RARITY_ADJUSTMENT[trait.toLowerCase()];
|
||||
if (adjustment) {
|
||||
dc += adjustment;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return { dc, type: matchedType, skills };
|
||||
}
|
||||
@@ -1,29 +1,14 @@
|
||||
/**
|
||||
* Backpressure check for biome-ignore comments.
|
||||
* Zero-tolerance check for biome-ignore comments.
|
||||
*
|
||||
* 1. Ratcheting cap — source and test files have separate max counts.
|
||||
* Lower these numbers as you fix ignores; they can never go up silently.
|
||||
* 2. Banned rules — ignoring certain rule categories is never allowed.
|
||||
* 3. Justification — every ignore must have a non-empty explanation after
|
||||
* the rule name.
|
||||
* Any `biome-ignore` in tracked .ts/.tsx files fails the build.
|
||||
* Fix the underlying issue instead of suppressing the rule.
|
||||
*/
|
||||
|
||||
import { execSync } from "node:child_process";
|
||||
import { readFileSync } from "node:fs";
|
||||
|
||||
// ── Configuration ──────────────────────────────────────────────────────
|
||||
const MAX_SOURCE_IGNORES = 2;
|
||||
const MAX_TEST_IGNORES = 3;
|
||||
|
||||
/** Rule prefixes that must never be suppressed. */
|
||||
const BANNED_PREFIXES = [
|
||||
"lint/security/",
|
||||
"lint/correctness/noGlobalObjectCalls",
|
||||
"lint/correctness/noUnsafeFinally",
|
||||
];
|
||||
// ───────────────────────────────────────────────────────────────────────
|
||||
|
||||
const IGNORE_PATTERN = /biome-ignore\s+([\w/]+)(?::\s*(.*))?/;
|
||||
const IGNORE_PATTERN = /biome-ignore\s+([\w/]+)/;
|
||||
|
||||
function findFiles() {
|
||||
return execSync("git ls-files -- '*.ts' '*.tsx'", { encoding: "utf-8" })
|
||||
@@ -32,17 +17,7 @@ function findFiles() {
|
||||
.filter(Boolean);
|
||||
}
|
||||
|
||||
function isTestFile(path) {
|
||||
return (
|
||||
path.includes("__tests__/") ||
|
||||
path.endsWith(".test.ts") ||
|
||||
path.endsWith(".test.tsx")
|
||||
);
|
||||
}
|
||||
|
||||
let errors = 0;
|
||||
let sourceCount = 0;
|
||||
let testCount = 0;
|
||||
let count = 0;
|
||||
|
||||
for (const file of findFiles()) {
|
||||
const lines = readFileSync(file, "utf-8").split("\n");
|
||||
@@ -51,58 +26,16 @@ for (const file of findFiles()) {
|
||||
const match = lines[i].match(IGNORE_PATTERN);
|
||||
if (!match) continue;
|
||||
|
||||
const rule = match[1];
|
||||
const justification = (match[2] ?? "").trim();
|
||||
const loc = `${file}:${i + 1}`;
|
||||
|
||||
// Count by category
|
||||
if (isTestFile(file)) {
|
||||
testCount++;
|
||||
} else {
|
||||
sourceCount++;
|
||||
}
|
||||
|
||||
// Banned rules
|
||||
for (const prefix of BANNED_PREFIXES) {
|
||||
if (rule.startsWith(prefix)) {
|
||||
console.error(`BANNED: ${loc} — ${rule} must not be suppressed`);
|
||||
errors++;
|
||||
}
|
||||
}
|
||||
|
||||
// Justification required
|
||||
if (!justification) {
|
||||
console.error(
|
||||
`MISSING JUSTIFICATION: ${loc} — biome-ignore ${rule} needs an explanation after the colon`,
|
||||
);
|
||||
errors++;
|
||||
}
|
||||
count++;
|
||||
console.error(`FORBIDDEN: ${file}:${i + 1} — biome-ignore ${match[1]}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Ratcheting caps
|
||||
if (sourceCount > MAX_SOURCE_IGNORES) {
|
||||
if (count > 0) {
|
||||
console.error(
|
||||
`SOURCE CAP EXCEEDED: ${sourceCount} biome-ignore comments in source (max ${MAX_SOURCE_IGNORES}). Fix issues and lower the cap.`,
|
||||
`\n${count} biome-ignore comment(s) found. Fix the issue or restructure the code.`,
|
||||
);
|
||||
errors++;
|
||||
}
|
||||
|
||||
if (testCount > MAX_TEST_IGNORES) {
|
||||
console.error(
|
||||
`TEST CAP EXCEEDED: ${testCount} biome-ignore comments in tests (max ${MAX_TEST_IGNORES}). Fix issues and lower the cap.`,
|
||||
);
|
||||
errors++;
|
||||
}
|
||||
|
||||
// Summary
|
||||
console.log(
|
||||
`biome-ignore: ${sourceCount} source (max ${MAX_SOURCE_IGNORES}), ${testCount} test (max ${MAX_TEST_IGNORES})`,
|
||||
);
|
||||
|
||||
if (errors > 0) {
|
||||
console.error(`\n${errors} problem(s) found.`);
|
||||
process.exit(1);
|
||||
} else {
|
||||
console.log("All checks passed.");
|
||||
console.log("biome-ignore: 0 — all clear.");
|
||||
}
|
||||
|
||||
@@ -98,10 +98,25 @@ A view button in the search bar (repurposed from the current search icon) opens
|
||||
**US-D3 — Responsive Layout (P4)**
|
||||
As a DM using the app on different devices, I want the layout to adapt between side-by-side (desktop) and drawer (mobile) so that the stat block is usable regardless of screen size.
|
||||
|
||||
**US-D4 — View Spell Descriptions Inline (P2)**
|
||||
As a DM running a PF2e encounter, I want to click a spell name in a creature's stat block to see the spell's full description without leaving the stat block, so I can quickly resolve what a spell does mid-combat without consulting external tools.
|
||||
|
||||
A click on any spell name in the spellcasting section opens a popover (desktop) or bottom sheet (mobile) showing the spell's description, level, traits, range, action cost, target/area, duration, defense/save, and heightening rules. The data is read directly from the cached creature data (already embedded in NPC JSON from Foundry VTT) — no additional network fetch is required, and the feature works offline once the source has been loaded. Dismiss with click-outside, Escape, or (on mobile) swipe-down.
|
||||
|
||||
**US-D5 — View Recall Knowledge DC and Skill (P2)**
|
||||
As a DM running a PF2e encounter, I want to see the Recall Knowledge DC and associated skill on a creature's stat block so I can quickly tell players the DC and which skill to roll without looking it up in external tools.
|
||||
|
||||
The Recall Knowledge line appears below the trait tags, showing the DC (calculated from the creature's level using the PF2e standard DC-by-level table, adjusted for rarity) and the skill determined by the creature's type trait. The line is omitted for creatures with no recognized type trait and never shown for D&D creatures.
|
||||
|
||||
**US-D6 — View NPC Equipment and Consumables (P2)**
|
||||
As a DM running a PF2e encounter, I want to see a creature's carried equipment — magic weapons, potions, scrolls, wands, and other items — displayed on its stat block so I can use these tactical options in combat without consulting external tools.
|
||||
|
||||
An "Equipment" section appears on the stat block listing each carried item with its name and relevant details (level, traits, activation description). Scrolls additionally show the embedded spell name and rank (e.g., "Scroll of Teleport (Rank 6)"). The section is omitted entirely for creatures that carry no equipment. Equipment data is extracted from the existing cached creature JSON — no additional fetch is required.
|
||||
|
||||
### Requirements
|
||||
|
||||
- **FR-016**: The system MUST display a stat block panel with full creature information when a creature is selected.
|
||||
- **FR-017**: For D&D creatures, the stat block MUST include: name, size, type, alignment, AC (with armor source if applicable), HP (average + formula), speed, ability scores with modifiers, saving throws, skills, damage vulnerabilities, damage resistances, damage immunities, condition immunities, senses, languages, challenge rating, proficiency bonus, passive perception, traits, actions, bonus actions, reactions, spellcasting, and legendary actions. For PF2e creatures, the stat block MUST include: name, level, traits (as tags), Perception and senses, languages, skills, ability modifiers (Str/Dex/Con/Int/Wis/Cha as modifiers, not scores), items, AC, saving throws (Fort/Ref/Will), HP (with optional immunities/resistances/weaknesses), speed, attacks, top abilities, mid abilities (reactions/auras), bot abilities (active), and spellcasting.
|
||||
- **FR-017**: For D&D creatures, the stat block MUST include: name, size, type, alignment, AC (with armor source if applicable), HP (average + formula), speed, ability scores with modifiers, saving throws, skills, damage vulnerabilities, damage resistances, damage immunities, condition immunities, senses, languages, challenge rating, proficiency bonus, passive perception, traits, actions, bonus actions, reactions, spellcasting, and legendary actions. For PF2e creatures, the stat block MUST include: name, level, traits (as tags), Perception (with details text such as "smoke vision" alongside senses), languages, skills, ability modifiers (Str/Dex/Con/Int/Wis/Cha as modifiers, not scores), items, AC, saving throws (Fort/Ref/Will), HP (with optional immunities/resistances/weaknesses), speed, attacks (with inline on-hit effects), abilities with frequency limits where applicable, top abilities, mid abilities (reactions/auras), bot abilities (active), spellcasting, and equipment (weapons, consumables, and other carried items).
|
||||
- **FR-018**: Optional stat block sections (traits, legendary actions, bonus actions, reactions, etc.) MUST be omitted entirely when the creature has none.
|
||||
- **FR-019**: The system MUST strip bestiary markup tags (spell references, dice notation, attack tags) and render them as plain readable text (e.g., `{@spell fireball|XPHB}` -> "fireball", `{@dice 3d6}` -> "3d6").
|
||||
- **FR-020**: On wide viewports (desktop), the layout MUST be side-by-side with the encounter tracker on the left and stat block on the right.
|
||||
@@ -116,6 +131,13 @@ As a DM using the app on different devices, I want the layout to adapt between s
|
||||
- **FR-067**: PF2e stat blocks MUST organize abilities into three sections: top (above defenses), mid (reactions and auras), and bot (active abilities), matching the Foundry VTT PF2e item categorization.
|
||||
- **FR-068**: PF2e stat blocks MUST strip HTML tags from Foundry VTT ability descriptions and render them as plain readable text. The HTML-to-text conversion serves the same role as the D&D tag-stripping approach (FR-019).
|
||||
- **FR-062**: Bestiary-linked combatant rows MUST display a small book icon (Lucide `BookOpen`) as the dedicated stat block trigger. The icon MUST have a tooltip ("View stat block") and an `aria-label="View stat block"` for accessibility. The book icon is the only way to manually open a stat block from the tracker — clicking the combatant name always enters inline rename mode. Non-bestiary combatant rows MUST NOT display the book icon.
|
||||
- **FR-077**: PF2e stat blocks MUST render each spell name in the spellcasting section as an interactive element (clickable button), not as plain joined text.
|
||||
- **FR-078**: Clicking a spell name MUST open a popover (desktop) or bottom sheet (mobile) displaying the spell's description, level, traits, range, time/actions, target/area, duration, defense/save, and heightening rules.
|
||||
- **FR-079**: The spell description popover/sheet MUST render content from the spell data already embedded in the cached creature JSON — no additional network fetch is required.
|
||||
- **FR-080**: The spell description popover/sheet MUST be dismissible by clicking outside, pressing Escape, or (on mobile) swiping the sheet down.
|
||||
- **FR-081**: Spell descriptions MUST be processed through the existing Foundry tag-stripping utility before display (consistent with FR-068).
|
||||
- **FR-082**: When a spell name has a parenthetical modifier (e.g., "Heal (×3)", "Unfettered Movement (Constant)"), only the spell name portion MUST be the click target; the modifier MUST remain as adjacent plain text.
|
||||
- **FR-083**: The spell description display MUST handle both representations of heightening present in Foundry VTT data: `system.heightening` and `system.overlays`.
|
||||
|
||||
### Acceptance Scenarios
|
||||
|
||||
@@ -131,12 +153,41 @@ As a DM using the app on different devices, I want the layout to adapt between s
|
||||
10. **Given** a bestiary-linked combatant row is visible, **When** the user clicks the combatant's name, **Then** inline rename mode is entered — the stat block does NOT open.
|
||||
11. **Given** a PF2e creature is selected, **When** the stat block opens, **Then** it displays: name, level, traits as tags, Perception, senses, languages, skills, ability modifiers, AC, Fort/Ref/Will saves, HP, speed, attacks, abilities (top/mid/bot sections), and spellcasting (if applicable). No CR, no ability scores, no legendary actions.
|
||||
12. **Given** a PF2e creature with conditional AC (e.g., "with shield raised"), **When** viewing the stat block, **Then** both the standard AC and conditional AC are shown.
|
||||
13. **Given** a PF2e creature with spellcasting is displayed in the stat block panel, **When** the DM clicks a spell name in the spellcasting section, **Then** a popover (desktop) or bottom sheet (mobile) opens showing the spell's description, level, traits, range, action cost, and any heightening rules.
|
||||
14. **Given** the spell description popover is open, **When** the DM clicks outside it or presses Escape, **Then** the popover dismisses.
|
||||
15. **Given** the spell description bottom sheet is open on mobile, **When** the DM swipes the sheet down, **Then** the sheet dismisses.
|
||||
16. **Given** a creature from a legacy (non-remastered) PF2e source has spells with pre-remaster names (e.g., "Magic Missile", "True Strike"), **When** the DM clicks one of those spell names, **Then** the spell description still displays correctly using the embedded data.
|
||||
17. **Given** a spell name appears as "Heal (×3)" in the stat block, **When** the DM looks at the rendered output, **Then** "Heal" is the clickable element and "(×3)" appears as plain text next to it.
|
||||
18. **Given** a PF2e creature with level 5 and common rarity is displayed, **When** the DM views the stat block, **Then** a "Recall Knowledge" line appears below the trait tags showing the DC calculated from level 5 (DC 20) and the skill derived from the creature's type trait.
|
||||
19. **Given** a PF2e creature with rare rarity is displayed, **When** the DM views the stat block, **Then** the Recall Knowledge DC is the standard DC for its level +5.
|
||||
20. **Given** a PF2e creature with the "Undead" type trait is displayed, **When** the DM views the stat block, **Then** the Recall Knowledge line shows "Religion" as the associated skill.
|
||||
21. **Given** a D&D creature is displayed, **When** the DM views the stat block, **Then** no Recall Knowledge line is shown.
|
||||
22. **Given** a PF2e creature carrying a Staff of Fire and an Invisibility Potion is displayed, **When** the DM views the stat block, **Then** an "Equipment" section appears listing both items with their names and relevant details.
|
||||
23. **Given** a PF2e creature carrying a Scroll of Teleport Rank 6 is displayed, **When** the DM views the stat block, **Then** the Equipment section shows the scroll with the embedded spell name and rank (e.g., "Scroll of Teleport (Rank 6)").
|
||||
24. **Given** a PF2e creature with no equipment items is displayed, **When** the DM views the stat block, **Then** no Equipment section is shown.
|
||||
25. **Given** a PF2e creature with equipment is displayed, **When** the DM views the stat block, **Then** equipment item descriptions have HTML tags stripped and render as plain readable text.
|
||||
26. **Given** a D&D creature is displayed, **When** the DM views the stat block, **Then** no Equipment section is shown (equipment display is PF2e-only).
|
||||
27. **Given** a PF2e creature with a melee attack that has `attackEffects: ["grab"]`, **When** the DM views the stat block, **Then** the attack line shows the damage followed by "plus Grab".
|
||||
28. **Given** a PF2e creature with a melee attack that has no attack effects, **When** the DM views the stat block, **Then** the attack line shows only the damage with no "plus" suffix.
|
||||
29. **Given** a PF2e creature with an ability that has `frequency: {max: 1, per: "day"}`, **When** the DM views the stat block, **Then** the ability name is followed by "(1/day)".
|
||||
30. **Given** a PF2e creature with an ability that has no frequency limit, **When** the DM views the stat block, **Then** the ability name renders without any frequency annotation.
|
||||
31. **Given** a PF2e creature with `perception.details: "smoke vision"`, **When** the DM views the stat block, **Then** the perception line shows "smoke vision" alongside the senses.
|
||||
32. **Given** a PF2e creature with no perception details, **When** the DM views the stat block, **Then** the perception line shows only the modifier and senses as before.
|
||||
|
||||
### Edge Cases
|
||||
|
||||
- Creatures with no traits or legendary actions: those sections are omitted from the stat block display.
|
||||
- Very long content (e.g., a Lich with extensive spellcasting): the stat block panel scrolls independently of the encounter tracker.
|
||||
- Viewport resized from wide to narrow while stat block is open: the layout transitions from panel to drawer.
|
||||
- Embedded spell item missing description text: the popover/sheet shows the available metadata (level, traits, range, etc.) and a placeholder note for the missing description.
|
||||
- Scroll item with missing or empty `system.spell` data: the scroll is displayed by name only, without spell name or rank.
|
||||
- Equipment item with empty description: the item is displayed with its name and metadata (level, traits) but no description text.
|
||||
- Cached source data from before the spell description feature was added: existing cached entries lack the new per-spell data fields. The IndexedDB schema version MUST be bumped to invalidate old caches and trigger re-fetch (re-normalization from raw Foundry data is not possible because the original raw JSON is not retained).
|
||||
- Creature with no recognized type trait (e.g., a creature whose only traits are not in the type-to-skill mapping): the Recall Knowledge line is omitted entirely.
|
||||
- Creature with a type trait that maps to multiple skills (e.g., Beast → Arcana/Nature): both skills are shown.
|
||||
- Attack with multiple on-hit effects (e.g., `["grab", "knockdown"]`): all effects shown, joined with "and" (e.g., "plus Grab and Knockdown").
|
||||
- Attack effect slug with creature-name prefix (e.g., `"lich-siphon-life"` on a Lich): the creature-name prefix is stripped, rendering as "Siphon Life".
|
||||
- Frequency `per` value variations (e.g., "day", "round", "turn"): the value is rendered as-is in the "(N/per)" format.
|
||||
|
||||
---
|
||||
|
||||
@@ -197,6 +248,23 @@ A DM wants to see which sources are cached, find a specific source, clear a spec
|
||||
- **FR-074**: The PF2e index MUST exclude legacy/pre-remaster creatures based on the `publication.remaster` field — only remaster-era content is included by default.
|
||||
- **FR-075**: PF2e creature abilities MUST have complete descriptive text in stat blocks. Stubs, generic feat references, and unresolved copy entries are not acceptable.
|
||||
- **FR-076**: The PF2e index SHOULD carry per-creature license tagging (ORC/OGL) derived from the Foundry VTT source data.
|
||||
- **FR-084**: The PF2e normalization pipeline MUST preserve per-spell data (slug, level, traits, range, time, target, area, duration, defense, description, heightening/overlays) from embedded `items[type=spell]` entries on NPCs, in addition to the spell name. This data MUST be stored in the cached source data and persisted across browser sessions.
|
||||
- **FR-085**: PF2e stat blocks MUST display a "Recall Knowledge" line below the trait tags showing the DC and the associated skill (e.g., "Recall Knowledge DC 18 • Undead (Religion)").
|
||||
- **FR-086**: The Recall Knowledge DC MUST be calculated from the creature's level using the PF2e standard DC-by-level table, adjusted for rarity: uncommon +2, rare +5, unique +10.
|
||||
- **FR-087**: The Recall Knowledge skill MUST be derived from the creature's type trait using the standard PF2e mapping (e.g., Aberration → Occultism, Animal → Nature, Astral → Occultism, Beast → Arcana/Nature, Celestial → Religion, Construct → Arcana/Crafting, Dragon → Arcana, Dream → Occultism, Elemental → Arcana/Nature, Ethereal → Occultism, Fey → Nature, Fiend → Religion, Fungus → Nature, Giant → Society, Humanoid → Society, Monitor → Religion, Ooze → Occultism, Plant → Nature, Undead → Religion).
|
||||
- **FR-088**: Creatures with no recognized type trait MUST omit the Recall Knowledge line entirely rather than showing incorrect data.
|
||||
- **FR-089**: The Recall Knowledge line MUST NOT be shown for D&D creatures.
|
||||
- **FR-090**: The PF2e normalization pipeline MUST extract `weapon` and `consumable` item types from the Foundry VTT `items[]` array, in addition to the existing `melee`, `action`, `spell`, and `spellcastingEntry` types. Each extracted equipment item MUST include name, level, traits, and description text.
|
||||
- **FR-091**: PF2e stat blocks MUST display an "Equipment" section listing all extracted equipment items. Each item MUST show its name and relevant details (e.g., level, traits, activation description).
|
||||
- **FR-092**: For scroll items, the stat block MUST display the embedded spell name and rank derived from the `system.spell` data on the item (e.g., "Scroll of Teleport (Rank 6)").
|
||||
- **FR-093**: The Equipment section MUST be omitted entirely when the creature has no equipment items, consistent with FR-018 (optional sections omitted when empty).
|
||||
- **FR-094**: Equipment item descriptions MUST be processed through the existing Foundry tag-stripping utility before display, consistent with FR-068 and FR-081.
|
||||
- **FR-095**: The PF2e normalization pipeline MUST extract `system.attackEffects.value` (an array of slug strings, e.g., `["grab"]`, `["lich-siphon-life"]`) from melee items and include them in the normalized attack data.
|
||||
- **FR-096**: PF2e attack lines MUST display inline on-hit effects after the damage text (e.g., "2d12+7 piercing plus Grab"). Effect slugs MUST be converted to title case with hyphens replaced by spaces; creature-name prefixes (e.g., "lich-" in "lich-siphon-life") MUST be stripped. Multiple effects MUST be joined with "plus" (e.g., "plus Grab and Knockdown"). Attacks without on-hit effects MUST render unchanged.
|
||||
- **FR-097**: The PF2e normalization pipeline MUST extract `system.frequency` (with `max` and `per` fields, e.g., `{max: 1, per: "day"}`) from action items and include it in the normalized ability data.
|
||||
- **FR-098**: PF2e abilities with a frequency limit MUST display it alongside the ability name as "(N/per)" (e.g., "(1/day)", "(1/round)"). Abilities without a frequency limit MUST render unchanged.
|
||||
- **FR-099**: The PF2e normalization pipeline MUST extract `system.perception.details` (a string, e.g., "smoke vision") and include it in the normalized creature perception data.
|
||||
- **FR-100**: PF2e stat blocks MUST display perception details text on the perception line alongside senses (e.g., "Perception +12; darkvision, smoke vision"). When no perception details are present, the perception line MUST render unchanged.
|
||||
|
||||
### Acceptance Scenarios
|
||||
|
||||
@@ -298,7 +366,7 @@ As a DM with a creature pinned, I want to collapse the right (browse) panel inde
|
||||
- **Search Index (D&D)** (`BestiaryIndex`): Pre-shipped lightweight dataset keyed by name + source, containing mechanical facts (name, source code, AC, HP average, DEX score, CR, initiative proficiency multiplier, size, type) for all creatures. Sufficient for adding combatants; insufficient for rendering a full stat block.
|
||||
- **Search Index (PF2e)** (`Pf2eBestiaryIndex`): Pre-shipped lightweight dataset for PF2e creatures, containing name, source code, AC, HP, level, Perception modifier, size, and creature type. Parallel to the D&D search index but with PF2e-specific fields (level instead of CR, Perception instead of DEX/proficiency).
|
||||
- **Source** (`BestiarySource`): A D&D or PF2e publication identified by a code (e.g., "XMM") with a display name (e.g., "Monster Manual (2025)"). Caching and fetching operate at the source level.
|
||||
- **Creature (Full)** (`Creature`): A complete creature record with all stat block data (traits, actions, legendary actions, spellcasting, etc.), available only after source data is fetched/uploaded and cached. Identified by a branded `CreatureId`.
|
||||
- **Creature (Full)** (`Creature`): A complete creature record with all stat block data (traits, actions, legendary actions, spellcasting, etc.), available only after source data is fetched/uploaded and cached. Identified by a branded `CreatureId`. For PF2e creatures, each spell entry inside `spellcasting` carries full per-spell data (slug, level, traits, range, action cost, target/area, duration, defense, description, heightening) extracted from the embedded `items[type=spell]` data on the source NPC, enabling inline spell description display without additional fetches. PF2e creatures also carry an `equipment` list of carried items (weapons, consumables) extracted from `items[type=weapon]` and `items[type=consumable]` entries, each with name, level, traits, description, and (for scrolls) embedded spell data. PF2e attack entries carry an optional `attackEffects` list of on-hit effect names. PF2e ability entries carry an optional `frequency` with `max` and `per` fields. PF2e creature perception carries an optional `details` string (e.g., "smoke vision").
|
||||
- **Cached Source Data**: The full normalized bestiary data for a single source, stored in IndexedDB. Contains complete creature stat blocks.
|
||||
- **Combatant** (extended): Gains an optional `creatureId` reference to a `Creature`, enabling stat block lookup and stat pre-fill on creation.
|
||||
- **Queued Creature**: Transient UI-only state representing a bestiary creature selected for batch-add, containing the creature reference and a count (1+). Not persisted.
|
||||
@@ -331,3 +399,5 @@ As a DM with a creature pinned, I want to collapse the right (browse) panel inde
|
||||
- **SC-019**: PF2e stat blocks render the correct layout (level, three saves, ability modifiers, ability sections) for all PF2e creatures — no D&D-specific fields (CR, ability scores, legendary actions) are shown.
|
||||
- **SC-020**: Switching game system immediately changes which creatures appear in search — no page reload required.
|
||||
- **SC-021**: Both D&D and PF2e search indexes ship bundled with the app; no network fetch is required to search creatures in either system.
|
||||
- **SC-022**: Clicking any spell in a PF2e creature's stat block opens its description display within 100ms — no network I/O is performed.
|
||||
- **SC-023**: PF2e spell descriptions are available offline once the bestiary source containing the creature has been cached.
|
||||
|
||||
Reference in New Issue
Block a user