@archivist-gg/dnd5e 0.3.11 → 0.3.17

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-2UDSN6VW.js";
+import "../chunk-6EI737IO.js";
+import "../chunk-3MGQFFNE.js";
 import "../chunk-IN4M4X7P.js";
-import "../chunk-2M34FLAY.js";
-import "../chunk-XTRDCSJB.js";
+import "../chunk-5MXFW4O3.js";
+import "../chunk-2JSQE3DD.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-6EI737IO.js";
+import "../chunk-3MGQFFNE.js";
 import "../chunk-IN4M4X7P.js";
-import "../chunk-2M34FLAY.js";
-import "../chunk-XTRDCSJB.js";
+import "../chunk-5MXFW4O3.js";
+import "../chunk-2JSQE3DD.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-3MGQFFNE.js";
 import "../chunk-IN4M4X7P.js";
-import "../chunk-2M34FLAY.js";
-import "../chunk-XTRDCSJB.js";
+import "../chunk-5MXFW4O3.js";
+import "../chunk-2JSQE3DD.js";
 import "../chunk-UA5KS2PL.js";
 export {
   backgroundEntitySchema,

package/dist/{chunk-XTRDCSJB.js → chunk-2JSQE3DD.js}

@@ -3,9 +3,21 @@ import { z } from "zod";
 var abilityEnum = z.enum(["str", "dex", "con", "int", "wis", "cha"]);
 var subjectField = z.string().min(1).optional();
 var conditionField = z.string().optional();
+var weaponScopeEnum = z.enum(["weapon", "melee", "ranged", "unarmed", "finesse", "thrown"]);
 var featureEffectSchema = z.discriminatedUnion("kind", [
   z.object({ kind: z.literal("initiative-bonus"), value: z.number().int(), condition: conditionField, subject: subjectField }),
   z.object({ kind: z.literal("skill-bonus"), skills: z.array(z.string().min(1)).nonempty(), ability: abilityEnum, minimum: z.number().int().optional(), condition: conditionField, subject: subjectField }),
+  // SL (2026-09-27): the `skill-bonus` twin for saving throws (Aura of Protection). `saves` absent = every save; `inactive_while` turns
+  // the bonus off while the character is incapacitated (any condition that disables actions) or unconscious.
+  z.object({
+    kind: z.literal("save-bonus"),
+    ability: abilityEnum,
+    minimum: z.number().int().optional(),
+    saves: z.array(abilityEnum).nonempty().optional(),
+    inactive_while: z.enum(["incapacitated", "unconscious"]).optional(),
+    condition: conditionField,
+    subject: subjectField
+  }),
   // Jack of All Trades / Remarkable Athlete: half the proficiency bonus, and ONLY on a skill the character is
   // not already proficient in — the "doesn't otherwise use your Proficiency Bonus" clause is the whole mechanic,
   // so it is the kind's semantics, not a field. `skills` omitted = every skill (Jack of All Trades); a list
@@ -68,7 +80,9 @@ var featureEffectSchema = z.discriminatedUnion("kind", [
     // canonical damage types. Do not tighten to an enum.
     damage_type: z.string().min(1),
     amount: z.string().min(1),
-    applies_to: z.enum(["weapon", "spell", "all"]).optional(),
+    // ART-c1 Task 9b: `spell` and `all` as before, or a weapon scope, one word or an any-of list, which the engine
+    // evaluates per attack row (pc.recalc.ts `riderReachesRow`). `weapon`, like an absent value, reaches every row.
+    applies_to: z.union([z.enum(["spell", "all"]), weaponScopeEnum, z.array(weaponScopeEnum).min(1)]).optional(),
     condition: conditionField,
     subject: subjectField
   }),

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-MAH6DCRI.js → chunk-2UDSN6VW.js}

@@ -1,6 +1,6 @@
 import {
   parseBackground
-} from "./chunk-4DOMDEBZ.js";
+} from "./chunk-6EI737IO.js";
 
 // src/background/background.codec.ts
 import yaml from "js-yaml";

package/dist/chunk-3LWMFYKS.js

@@ -0,0 +1,57 @@
+import {
+  classifyWeaponRange
+} from "./chunk-YDGMBMYI.js";
+
+// src/pc/pc.weapon-grant.ts
+var PROPERTY_KEY = {
+  "2h": "two_handed",
+  "two-handed": "two_handed",
+  "two handed": "two_handed",
+  h: "heavy",
+  l: "light",
+  f: "finesse",
+  t: "thrown",
+  v: "versatile",
+  r: "reach",
+  a: "ammunition",
+  ld: "loading",
+  s: "special"
+};
+var propertyKey = (word) => {
+  var _a;
+  const w = word.trim().toLowerCase();
+  return (_a = PROPERTY_KEY[w]) != null ? _a : w.replace(/[\s-]+/g, "_");
+};
+var GRANT_RE = new RegExp(
+  "^(?:all\\s+)?(?:(melee|ranged)\\s+)?(simple|martial)(?:\\s+(melee|ranged))?\\s+weapons?\\s+(?:that|which)\\s+(have|has|don'?t\\s+have|do\\s+not\\s+have|doesn'?t\\s+have|does\\s+not\\s+have)\\s+the\\s+(.+?)\\s+propert(?:y|ies)\\.?$",
+  "i"
+);
+function parseQualifiedWeaponGrant(text) {
+  var _a, _b;
+  const m = GRANT_RE.exec(text.replace(/’/g, "'").trim().replace(/\s+/g, " "));
+  if (!m) return null;
+  const range = (_b = (_a = m[1]) != null ? _a : m[3]) == null ? void 0 : _b.toLowerCase();
+  const properties = m[5].split(/\s*,\s*|\s+or\s+|\s+and\s+/i).map((w) => w.trim()).filter(Boolean).map(propertyKey);
+  if (properties.length === 0) return null;
+  return {
+    category: m[2].toLowerCase(),
+    ...range ? { range } : {},
+    properties,
+    without: /n'?t|not/i.test(m[4])
+  };
+}
+function qualifiedGrantCovers(text, weapon) {
+  const g = parseQualifiedWeaponGrant(text);
+  if (!g || typeof weapon.category !== "string") return false;
+  if (!new RegExp(`^${g.category}\\b`).test(weapon.category)) return false;
+  if (g.range) {
+    const melee = classifyWeaponRange(weapon).melee !== null;
+    if (g.range === "melee" !== melee) return false;
+  }
+  const has = g.properties.some((p) => weapon.properties.some((x) => x === p));
+  return g.without ? !has : has;
+}
+
+export {
+  qualifiedGrantCovers
+};

package/dist/{chunk-JCEV7KYN.js → chunk-3MGQFFNE.js}

@@ -3,7 +3,7 @@ import {
 } from "./chunk-IN4M4X7P.js";
 import {
   choiceSchema
-} from "./chunk-2M34FLAY.js";
+} from "./chunk-5MXFW4O3.js";
 import {
   additionalSpellsEntrySchema,
   imageField