@archivist-gg/dnd5e 0.3.11 → 0.3.13

package/LICENSES/SRD.md

@@ -27,8 +27,9 @@ Coast. This project is unofficial and not affiliated with or endorsed by Wizards
 
 ## Provenance and changes made (CC-BY "indicate if changes were made")
 
-The shipped SRD data is MODIFIED, and it is a MERGE. It was not taken from the SRD PDFs. It is
-assembled by `tools/srd-canonical/` from:
+The shipped SRD data is MODIFIED, and it is a MERGE. Apart from the few SRD 5.2 equipment
+descriptions transcribed from the document itself (below), it was not taken from the SRD PDFs. It
+is assembled by `tools/srd-canonical/` from:
 
 - the **Open5e** v2 API, queried with the official-SRD document filter
   `document__key__in=srd-2014` / `srd-2024`, the immediate redistribution source of the SRD
@@ -36,8 +37,13 @@ assembled by `tools/srd-canonical/` from:
 - a structured-rules JSON dump, used to enrich mechanical fields, to expand the SRD's generic
   magic-item variants into one entity per base item, and, for the 15 conditions per edition, as
   the text source (Open5e exposes no condition endpoint for these documents);
+- the **SRD 5.2** document itself (`SRD_CC_v5.2.pdf`,
+  https://media.dndbeyond.com/compendium-images/srd/5.2/SRD_CC_v5.2.pdf, CC-BY-4.0), for the
+  2024 equipment descriptions Open5e does not carry, transcribed verbatim into the overlay (see
+  the equipment paragraph below);
 - virtual-tabletop activation data, used to derive typed item effects;
-- a hand-curated overlay (`tools/srd-canonical/overlays/`), authored for this project.
+- a hand-curated overlay (`tools/srd-canonical/overlays/`), authored for this project apart from
+  the SRD 5.2 transcriptions it carries.
 
 Content is reformatted to this project's schema and to Markdown, cross-references become vault
 wikilinks, and dice and save expressions become this project's inline roll tags; narrative prose
@@ -53,4 +59,33 @@ the ENTITY and not about every byte of its text, the emit path additionally runs
 markup (reference tags, source-book abbreviation suffixes, template pointers, third-party
 database identifiers) and the editorial commentary its contributors wrote about the SRD.
 
+The mundane equipment (adventuring gear including the packs and poisons, ammunition, spellcasting
+foci, artisan's tools, tools, musical instruments and gaming sets; the gear pass,
+`tools/srd-canonical/merger-rules/gear-merge.ts`) follows the same rules. A record is selected by
+the structured-rules dump's own per-entry SRD flags or, for the members listed in
+`tools/srd-canonical/data/gear-open5e-join.json` (Map, String, Firearm Bullets (10), Dragonchess
+Set and Three-Dragon Ante Set, which Open5e's `srd-2024` document carries but the dump leaves
+unflagged), by Open5e's document filter. Firearm Bullet, also listed, ships as the single piece of
+the SRD's Firearm Bullets (10), as the flagged single pieces (Arrow, Bolt, Needle, Sling Bullet)
+do for their bundles. Names, structure (type, weight, cost, focus kind, container capacity) and
+the `pack_contents` strings, including the seven SRD pack phrases that name no item of their own
+("10 feet of string", "alms box", "block of incense", "censer", "vestments", "little bag of
+sand", "small knife"), come from the structured-rules data, a name being the SRD name the dump
+records where it records one; two SRD 5.2 poisons carry their SRD 5.2 names, Spider's Sting and
+Crawler Mucus. The container data of the following records comes instead from the hand-curated
+overlay: the Portable Hole (a magic item, in both editions), marked as a container whose
+contents weigh nothing, where the dump carries no container capacity; the 2014 Scholar's Pack,
+whose `pack_contents` carry the ten sheets of parchment its SRD 5.1 description names
+(`Parchment (one sheet) (x10)`), where the dump lists one; and the 2024 Chest and Vial, whose
+`holds_items` says the Chest holds items (the dump gives it a volume only) and the Vial (which
+holds up to 4 ounces of liquid) holds no items. The text comes from Open5e (its items and item
+sets under the same document filter), never from the structured-rules dump. The 2024 records
+without usable Open5e text
+(fourteen poisons, the five arcane foci and the Glass Bottle, each listed with its page in
+`tools/srd-canonical/overlays/srd-2024.yaml`) are transcribed verbatim from the SRD 5.2 document
+and checked against it by `tools/srd-canonical/verify-srd52-transcriptions.ts`. The 2024 Belt of
+Giant Strength (Frost or Stone) takes its Strength score, 23, from the hand-curated overlay,
+transcribed from the SRD 5.2 table, because the structured-rules data names the frost and stone
+giants' belts separately.
+
 Credit to **Open5e** (https://open5e.com) as the immediate SRD-redistribution source.

package/dist/armor/armor.codec.js

@@ -1,8 +1,8 @@
 import {
   armorCodec
-} from "../chunk-AW3EHF3L.js";
-import "../chunk-5N2GW72F.js";
-import "../chunk-JC5UNIVM.js";
+} from "../chunk-FC4IGH5Y.js";
+import "../chunk-UZXG6QSY.js";
+import "../chunk-HS6FIOLP.js";
 import "../chunk-UA5KS2PL.js";
 export {
   armorCodec

package/dist/armor/armor.parser.js

@@ -1,7 +1,7 @@
 import {
   parseArmor
-} from "../chunk-5N2GW72F.js";
-import "../chunk-JC5UNIVM.js";
+} from "../chunk-UZXG6QSY.js";
+import "../chunk-HS6FIOLP.js";
 import "../chunk-UA5KS2PL.js";
 export {
   parseArmor

package/dist/armor/armor.schema.d.ts

@@ -22,6 +22,7 @@ export declare const armorEntitySchema: z.ZodObject<{
     edition: z.ZodOptional<z.ZodString>;
     entries: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
     rendering_hint: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
     has_fluff: z.ZodOptional<z.ZodBoolean>;
     has_fluff_images: z.ZodOptional<z.ZodBoolean>;
     image: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;

package/dist/armor/armor.schema.js

@@ -1,6 +1,6 @@
 import {
   armorEntitySchema
-} from "../chunk-JC5UNIVM.js";
+} from "../chunk-HS6FIOLP.js";
 import "../chunk-UA5KS2PL.js";
 export {
   armorEntitySchema

package/dist/armor/armor.types.d.ts

@@ -26,6 +26,8 @@ export interface ArmorEntity {
     entries?: unknown[];
     /** Carried as the empty string on every converter armor carrier today (27). */
     rendering_hint?: string;
+    /** The icon key (I3): a key of the renderer's icon set or a Lucide name. */
+    icon?: string;
     has_fluff?: boolean;
     has_fluff_images?: boolean;
     /** One wikilink, or an array for >= 2 fluff images (images-ON emit). */

package/dist/background/background.codec.js

@@ -1,11 +1,11 @@
 import {
   backgroundCodec
-} from "../chunk-MAH6DCRI.js";
-import "../chunk-4DOMDEBZ.js";
-import "../chunk-JCEV7KYN.js";
+} from "../chunk-Q6UOHCCT.js";
+import "../chunk-RQNJXADQ.js";
+import "../chunk-MUIU7RZ3.js";
 import "../chunk-IN4M4X7P.js";
-import "../chunk-2M34FLAY.js";
-import "../chunk-XTRDCSJB.js";
+import "../chunk-BRGLDWUP.js";
+import "../chunk-ZMJQUZQH.js";
 import "../chunk-UA5KS2PL.js";
 export {
   backgroundCodec

package/dist/background/background.parser.js

@@ -1,10 +1,10 @@
 import {
   parseBackground
-} from "../chunk-4DOMDEBZ.js";
-import "../chunk-JCEV7KYN.js";
+} from "../chunk-RQNJXADQ.js";
+import "../chunk-MUIU7RZ3.js";
 import "../chunk-IN4M4X7P.js";
-import "../chunk-2M34FLAY.js";
-import "../chunk-XTRDCSJB.js";
+import "../chunk-BRGLDWUP.js";
+import "../chunk-ZMJQUZQH.js";
 import "../chunk-UA5KS2PL.js";
 export {
   parseBackground

package/dist/background/background.schema.js

@@ -1,10 +1,10 @@
 import {
   backgroundEntitySchema,
   langProfSchema
-} from "../chunk-JCEV7KYN.js";
+} from "../chunk-MUIU7RZ3.js";
 import "../chunk-IN4M4X7P.js";
-import "../chunk-2M34FLAY.js";
-import "../chunk-XTRDCSJB.js";
+import "../chunk-BRGLDWUP.js";
+import "../chunk-ZMJQUZQH.js";
 import "../chunk-UA5KS2PL.js";
 export {
   backgroundEntitySchema,

package/dist/chunk-2LULMQTF.js

@@ -0,0 +1,14 @@
+// src/types/equipment-grant.ts
+function isCategoryGrant(g) {
+  return !!g && typeof g === "object" && typeof g.category === "string" && g.category.length > 0;
+}
+var equipmentCategoryKey = (i, j, k) => `equipment-${i}-opt-${j}-cat-${k}`;
+var equipmentCategoryKeys = (grants, i, j) => grants.flatMap((g, k) => isCategoryGrant(g) ? [equipmentCategoryKey(i, j, k)] : []);
+var isStartingEquipmentKey = (key) => key.startsWith("equipment-");
+
+export {
+  isCategoryGrant,
+  equipmentCategoryKey,
+  equipmentCategoryKeys,
+  isStartingEquipmentKey
+};

package/dist/{chunk-CBEKVAX4.js → chunk-4BZ47YJ4.js}

@@ -9,7 +9,7 @@ import {
 } from "./chunk-LVQLWRCU.js";
 import {
   bareEntitySlug
-} from "./chunk-6X4KUDMU.js";
+} from "./chunk-ZCTUYGNV.js";
 import {
   normalizeAbility
 } from "./chunk-WELIKLZF.js";
@@ -88,7 +88,7 @@ function assembleEffectFeatures(resolved) {
   const pushBoon = (item, pool) => {
     var _a2, _b2, _c2, _d2, _e2, _f2, _g2;
     const e = item.entity;
-    if (!e || ((_b2 = (_a2 = e.effects) == null ? void 0 : _a2.length) != null ? _b2 : 0) === 0) return;
+    if (!e || item.itemBound === true || ((_b2 = (_a2 = e.effects) == null ? void 0 : _a2.length) != null ? _b2 : 0) === 0) return;
     buffFeatures.push({
       feature: { id: item.slug, name: e.name, activatable: (_c2 = e.activatable) != null ? _c2 : false, effects: e.effects },
       // source is inert for the fold; attribute to the pool's owning class
@@ -182,6 +182,11 @@ function scaled(base, key, scalesAt, level) {
   }
   return best;
 }
+function riderScope(appliesTo) {
+  if (appliesTo === void 0 || appliesTo === "all" || appliesTo === "spell") return void 0;
+  const words = Array.isArray(appliesTo) ? appliesTo : [appliesTo];
+  return words.includes("weapon") ? void 0 : [...words];
+}
 function applyEffect(out, eff, label, level) {
   var _a, _b, _c, _d, _e, _f, _g, _h;
   switch (eff.kind) {
@@ -296,11 +301,13 @@ function applyEffect(out, eff, label, level) {
       break;
     case "damage-bonus":
       if (((_g = eff.applies_to) != null ? _g : "weapon") !== "spell") {
+        const scope = riderScope(eff.applies_to);
         out.damageBonuses.push({
           amount: eff.amount,
           damage_type: eff.damage_type,
           source: label,
-          ...eff.condition ? { condition: eff.condition } : {}
+          ...eff.condition ? { condition: eff.condition } : {},
+          ...scope ? { scope } : {}
         });
       }
       break;

package/dist/{chunk-T2SNEJOE.js → chunk-4SLOJXJ4.js}

@@ -1,6 +1,6 @@
 import {
   featEntitySchema
-} from "./chunk-U3BABVJF.js";
+} from "./chunk-LVX6TQ3R.js";
 
 // src/feat/feat.parser.ts
 import { parseYaml } from "@archivist-gg/core";

package/dist/{chunk-2DFENQIJ.js → chunk-5GKJAUMX.js}

@@ -40,6 +40,8 @@ var weaponEntitySchema = z.object({
   // string today, so `.min(1)` is forbidden here.
   rendering_hint: z.string().optional(),
   // 98
+  // The icon key (I3): a key of the renderer's icon set or a Lucide name; itemIconKey reads it first.
+  icon: z.string().optional(),
   has_fluff: z.boolean().optional(),
   // 1
   has_fluff_images: z.boolean().optional(),

package/dist/{chunk-J77CKYV3.js → chunk-5KGV6TF7.js}

@@ -1,6 +1,6 @@
 import {
   subclassEntitySchema
-} from "./chunk-BLRW2UU6.js";
+} from "./chunk-J53ERF6K.js";
 import {
   aliasFeaturesByLevelActionCost
 } from "./chunk-4U55VNC7.js";

package/dist/{chunk-CHUALUIX.js → chunk-6ZY3U6BQ.js}

@@ -1,6 +1,6 @@
 import {
   parseFeat
-} from "./chunk-T2SNEJOE.js";
+} from "./chunk-4SLOJXJ4.js";
 
 // src/feat/feat.codec.ts
 import yaml from "js-yaml";

package/dist/{chunk-DNAJRMNN.js → chunk-A54HHCWW.js}

@@ -1,3 +1,7 @@
+import {
+  isTwoHandedWeapon
+} from "./chunk-LHZXYFBU.js";
+
 // src/item/item.conditions.ts
 function unwrapSlug(maybeWiki) {
   if (!maybeWiki) return "";
@@ -11,13 +15,8 @@ function evaluateCondition(cond, ctx) {
       return ctx.derived.equippedSlots.armor === void 0 ? "true" : "false";
     case "no_shield":
       return ctx.derived.equippedSlots.shield === void 0 ? "true" : "false";
-    case "wielding_two_handed": {
-      const main = (_a = ctx.derived.equippedSlots.mainhand) == null ? void 0 : _a.entity;
-      if (!main || typeof main !== "object" || !("properties" in main)) return "false";
-      const props = main.properties;
-      if (!Array.isArray(props)) return "false";
-      return props.some((p) => p === "two_handed") ? "true" : "false";
-    }
+    case "wielding_two_handed":
+      return isTwoHandedWeapon((_a = ctx.derived.equippedSlots.mainhand) == null ? void 0 : _a.entity, ctx.registry) ? "true" : "false";
     case "is_class": {
       const target = cond.value.toLowerCase();
       return ctx.classList.some((c) => unwrapSlug(c.name) === target) ? "true" : "false";

package/dist/{chunk-2M34FLAY.js → chunk-BRGLDWUP.js}

@@ -1,6 +1,6 @@
 import {
   featureEffectSchema
-} from "./chunk-XTRDCSJB.js";
+} from "./chunk-ZMJQUZQH.js";
 
 // src/schemas/choice-schema.ts
 import { z } from "zod";
@@ -12,6 +12,8 @@ var entityFilterSchema = z.object({
   available_to: z.literal("self").optional(),
   weapon_category: z.enum(["simple", "martial"]).optional(),
   armor_category: z.enum(["light", "medium", "heavy", "shield"]).optional(),
+  item_type: z.array(z.string().min(1)).nonempty().optional(),
+  mundane: z.boolean().optional(),
   list: z.string().min(1).optional(),
   level: z.number().int().min(0).max(9).optional(),
   edition: z.string().min(1).optional()