Compare commits

..

1 Commits

Author SHA1 Message Date
Lukas
e44e56b09b Add PF2e equipment display with detail popovers in stat blocks
All checks were successful
CI / check (push) Successful in 2m31s
CI / build-image (push) Successful in 19s
Extract shared DetailPopover shell from spell popovers. Normalize
weapon/consumable/equipment/armor items from Foundry data into
mundane (Items line) and detailed (Equipment section with clickable
popovers). Scrolls/wands show embedded spell info. Bump IDB cache v7.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-10 20:21:11 +02:00
9 changed files with 44 additions and 106 deletions

View File

@@ -879,8 +879,7 @@ describe("normalizeFoundryCreature", () => {
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);
expect(sc?.atWill?.[0]?.rank).toBe(1);
});
it("normalizes innate spells with uses", () => {

View File

@@ -99,15 +99,9 @@ describe("stripFoundryTags", () => {
expect(stripFoundryTags("before<hr />after")).toBe("before\nafter");
});
it("preserves strong and em tags", () => {
it("strips strong and em tags", () => {
expect(stripFoundryTags("<strong>bold</strong> <em>italic</em>")).toBe(
"<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>",
"bold italic",
);
});

View File

@@ -470,25 +470,16 @@ function formatOverlays(overlays: SpellSystem["overlays"]): string | undefined {
*/
const HEIGHTENED_SUFFIX = /\s*Heightened\s*\([^)]*\)[\s\S]*$/;
function normalizeSpell(
item: RawFoundryItem,
creatureLevel: number,
): SpellReference {
function normalizeSpell(item: RawFoundryItem): 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 rank = sys.location?.heightenedLevel ?? 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();
}
@@ -516,7 +507,6 @@ function normalizeSpell(
function normalizeSpellcastingEntry(
entry: RawFoundryItem,
allSpells: readonly RawFoundryItem[],
creatureLevel: number,
): SpellcastingBlock {
const sys = entry.system as unknown as SpellcastingEntrySystem;
const tradition = capitalize(sys.tradition?.value ?? "");
@@ -535,7 +525,7 @@ function normalizeSpellcastingEntry(
const cantrips: SpellReference[] = [];
for (const spell of linkedSpells) {
const ref = normalizeSpell(spell, creatureLevel);
const ref = normalizeSpell(spell);
const isCantrip =
(spell.system as unknown as SpellSystem).traits?.value?.includes(
"cantrip",
@@ -568,13 +558,10 @@ 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, creatureLevel),
);
return entries.map((entry) => normalizeSpellcastingEntry(entry, spells));
}
// -- Main normalization --
@@ -713,9 +700,7 @@ export function normalizeFoundryCreature(
),
),
abilitiesBot: orUndefined(actionsByCategory(items, "offensive")),
spellcasting: orUndefined(
normalizeSpellcasting(items, sys.details?.level?.value ?? 0),
),
spellcasting: orUndefined(normalizeSpellcasting(items)),
items:
items
.filter(isMundaneItem)

View File

@@ -8,13 +8,7 @@
function formatDamage(params: string): string {
// "3d6+10[fire]" → "3d6+10 fire"
// "d4[persistent,fire]" → "d4 persistent fire"
return params
.replaceAll(
/\[([^\]]*)\]/g,
(_, type: string) => ` ${type.replaceAll(",", " ")}`,
)
.trim();
return params.replaceAll(/\[([^\]]*)\]/g, " $1").trim();
}
function formatCheck(params: string): string {
@@ -86,11 +80,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 (preserve <strong> for UI rendering)
// Strip HTML tags
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(/<(?!\/?(?:strong|em|ul|ol|li)\b)[^>]+>/g, "");
result = result.replaceAll(/<[^>]+>/g, "");
// Decode common HTML entities
result = result.replaceAll("&amp;", "&");
@@ -98,11 +92,6 @@ export function stripFoundryTags(html: string): string {
result = result.replaceAll("&gt;", ">");
result = result.replaceAll("&quot;", '"');
// 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");

View File

@@ -1,6 +1,5 @@
import type { EquipmentItem } from "@initiative/domain";
import { DetailPopover } from "./detail-popover.js";
import { RichDescription } from "./rich-description.js";
interface EquipmentDetailPopoverProps {
readonly item: EquipmentItem;
@@ -42,10 +41,9 @@ function EquipmentDetailContent({ item }: Readonly<{ item: EquipmentItem }>) {
) : null}
</div>
{item.description ? (
<RichDescription
text={item.description}
className="whitespace-pre-line text-foreground"
/>
<p className="whitespace-pre-line text-foreground">
{item.description}
</p>
) : (
<p className="text-muted-foreground italic">
No description available.

View File

@@ -1,20 +0,0 @@
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} />;
}

View File

@@ -1,6 +1,5 @@
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 {
@@ -135,6 +134,24 @@ function SpellMeta({ spell }: Readonly<{ spell: SpellReference }>) {
);
}
const SAVE_OUTCOME_REGEX =
/(Critical Success|Critical Failure|Success|Failure)/g;
function SpellDescription({ text }: Readonly<{ text: string }>) {
const parts = text.split(SAVE_OUTCOME_REGEX);
const elements: React.ReactNode[] = [];
let offset = 0;
for (const part of parts) {
if (SAVE_OUTCOME_REGEX.test(part)) {
elements.push(<strong key={`b-${offset}`}>{part}</strong>);
} else if (part) {
elements.push(<span key={`t-${offset}`}>{part}</span>);
}
offset += part.length;
}
return <p className="whitespace-pre-line text-foreground">{elements}</p>;
}
function SpellDetailContent({ spell }: Readonly<{ spell: SpellReference }>) {
return (
<div className="space-y-2 text-sm">
@@ -142,20 +159,16 @@ function SpellDetailContent({ spell }: Readonly<{ spell: SpellReference }>) {
<SpellTraits traits={spell.traits ?? []} />
<SpellMeta spell={spell} />
{spell.description ? (
<RichDescription
text={spell.description}
className="whitespace-pre-line text-foreground"
/>
<SpellDescription text={spell.description} />
) : (
<p className="text-muted-foreground italic">
No description available.
</p>
)}
{spell.heightening ? (
<RichDescription
text={spell.heightening}
className="whitespace-pre-line text-foreground text-xs"
/>
<p className="whitespace-pre-line text-foreground text-xs">
{spell.heightening}
</p>
) : null}
</div>
);

View File

@@ -3,7 +3,6 @@ import type {
TraitBlock,
TraitSegment,
} from "@initiative/domain";
import { RichDescription } from "./rich-description.js";
export function PropertyLine({
label,
@@ -40,22 +39,20 @@ function TraitSegments({
{segments.map((seg, i) => {
if (seg.type === "text") {
return (
<RichDescription
key={segmentKey(seg)}
text={i === 0 ? ` ${seg.value}` : seg.value}
className="inline whitespace-pre-line"
/>
<span key={segmentKey(seg)}>
{i === 0 ? ` ${seg.value}` : seg.value}
</span>
);
}
return (
<div key={segmentKey(seg)} className="mt-1 space-y-0.5">
{seg.items.map((item) => (
<div key={item.label ?? item.text}>
<p key={item.label ?? item.text}>
{item.label != null && (
<span className="font-semibold">{item.label}. </span>
)}
<RichDescription text={item.text} className="inline" />
</div>
{item.text}
</p>
))}
</div>
);

View File

@@ -108,15 +108,10 @@ As a DM running a PF2e encounter, I want to see the Recall Knowledge DC and asso
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), spellcasting, and equipment (weapons, consumables, and other carried items).
- **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-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.
@@ -162,11 +157,6 @@ An "Equipment" section appears on the stat block listing each carried item with
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).
### Edge Cases
@@ -174,8 +164,6 @@ An "Equipment" section appears on the stat block listing each carried item with
- 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.
@@ -245,11 +233,6 @@ A DM wants to see which sources are cached, find a specific source, clear a spec
- **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.
### Acceptance Scenarios
@@ -351,7 +334,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`. 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.
- **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.
- **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.