@archivist-gg/dnd5e 0.3.1 → 0.3.4

package/LICENSES/SRD.md

@@ -27,11 +27,30 @@ 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 a MERGE, assembled by `tools/srd-canonical/` from: the **Open5e** v2
-API (the immediate redistribution source of the SRD content), a structured-rules dump, and
-supplemental activation data, combined with a hand-curated overlay. Content is transformed
-structurally (reformatted to this project's schema and to Markdown) and normalized; narrative
-prose is preserved. **No non-SRD content is bundled** — every shipped entry's `source` field is
-`SRD 5.1` or `SRD 5.2` (verified: see the repository's SRD-content assertion).
+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 **Open5e** v2 API, queried with the official-SRD document filter
+  `document__key__in=srd-2014` / `srd-2024`, the immediate redistribution source of the SRD
+  text, itself a CC-BY-4.0 redistribution;
+- 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);
+- virtual-tabletop activation data, used to derive typed item effects;
+- a hand-curated overlay (`tools/srd-canonical/overlays/`), authored for this project.
+
+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
+is preserved and no mechanics are invented. A small number of entities with no SRD counterpart
+(the base Shield entry, an Ability Score Improvement entry, spell scrolls and unidentified-item
+placeholders) are authored here and marked as such.
+
+Entity selection is governed by Open5e's document filter and by the structured-rules dump's own
+per-entry SRD flags: every shipped entry's `source` field is `SRD 5.1` or `SRD 5.2`, and no
+content from a non-SRD publication is bundled. Because a correct `source` field is a claim about
+the ENTITY and not about every byte of its text, the emit path additionally runs
+`tools/srd-canonical/sanitize.ts` over every file it writes, removing the upstream tooling's own
+markup (reference tags, source-book abbreviation suffixes, template pointers, third-party
+database identifiers) and the editorial commentary its contributors wrote about the SRD.
 
 Credit to **Open5e** (https://open5e.com) as the immediate SRD-redistribution source.

package/dist/armor/armor.codec.js

@@ -1,8 +1,9 @@
 import {
   armorCodec
-} from "../chunk-ZMR77DDL.js";
-import "../chunk-HCP3GMHS.js";
-import "../chunk-XJNECUPT.js";
+} from "../chunk-AW3EHF3L.js";
+import "../chunk-5N2GW72F.js";
+import "../chunk-JC5UNIVM.js";
+import "../chunk-UA5KS2PL.js";
 export {
   armorCodec
 };

package/dist/armor/armor.parser.js

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

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

@@ -21,5 +21,9 @@ export declare const armorEntitySchema: z.ZodObject<{
     page: z.ZodOptional<z.ZodNumber>;
     edition: z.ZodOptional<z.ZodString>;
     entries: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    rendering_hint: 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>]>>;
     raw: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$loose>;

package/dist/armor/armor.schema.js

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

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

@@ -1,3 +1,5 @@
+import type { imageField } from "@archivist-gg/dnd5e/schemas/entity-extras-schema";
+import type { z } from "zod";
 export type { Ability } from "@archivist-gg/dnd5e/types/choice";
 export type ArmorCategory = "light" | "medium" | "heavy" | "shield" | "natural" | "feature" | "spell" | string;
 export interface ArmorEntity {
@@ -22,5 +24,11 @@ export interface ArmorEntity {
     page?: number;
     edition?: "2014" | "2024" | string;
     entries?: unknown[];
+    /** Carried as the empty string on every converter armor carrier today (27). */
+    rendering_hint?: string;
+    has_fluff?: boolean;
+    has_fluff_images?: boolean;
+    /** One wikilink, or an array for >= 2 fluff images (images-ON emit). */
+    image?: z.infer<typeof imageField>;
     raw?: Record<string, unknown>;
 }

package/dist/background/background.codec.js

@@ -1,11 +1,12 @@
 import {
   backgroundCodec
-} from "../chunk-BIK4DFWK.js";
-import "../chunk-5ZBE4CWV.js";
-import "../chunk-SE7AZDR3.js";
-import "../chunk-3DZ74AKK.js";
-import "../chunk-NXSWH3AE.js";
-import "../chunk-NXR3BD2V.js";
+} from "../chunk-HJ5EEZ47.js";
+import "../chunk-LMBAEIP6.js";
+import "../chunk-JRDPUDT5.js";
+import "../chunk-IN4M4X7P.js";
+import "../chunk-T26ZVCL5.js";
+import "../chunk-WPWOHGPI.js";
+import "../chunk-UA5KS2PL.js";
 export {
   backgroundCodec
 };

package/dist/background/background.parser.js

@@ -1,10 +1,11 @@
 import {
   parseBackground
-} from "../chunk-5ZBE4CWV.js";
-import "../chunk-SE7AZDR3.js";
-import "../chunk-3DZ74AKK.js";
-import "../chunk-NXSWH3AE.js";
-import "../chunk-NXR3BD2V.js";
+} from "../chunk-LMBAEIP6.js";
+import "../chunk-JRDPUDT5.js";
+import "../chunk-IN4M4X7P.js";
+import "../chunk-T26ZVCL5.js";
+import "../chunk-WPWOHGPI.js";
+import "../chunk-UA5KS2PL.js";
 export {
   parseBackground
 };

package/dist/background/background.schema.d.ts

@@ -79,4 +79,30 @@ export declare const backgroundEntitySchema: z.ZodObject<{
         flaws: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>>;
     choices: z.ZodOptional<z.ZodArray<z.ZodType<import("../index.js").Choice, unknown, z.core.$ZodTypeInternals<import("../index.js").Choice, unknown>>>>;
+    rendering_hint: z.ZodOptional<z.ZodString>;
+    has_fluff_images: z.ZodOptional<z.ZodBoolean>;
+    tables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        dice: z.ZodString;
+        rows: z.ZodArray<z.ZodObject<{
+            roll: z.ZodString;
+            text: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    additional_spells: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        ability: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            choose: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>]>>;
+        known: z.ZodOptional<z.ZodUnknown>;
+        innate: z.ZodOptional<z.ZodUnknown>;
+        prepared: z.ZodOptional<z.ZodUnknown>;
+        expanded: z.ZodOptional<z.ZodUnknown>;
+        resourceName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    prerequisites: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        kind: z.ZodLiteral<"campaign">;
+        slug: z.ZodString;
+    }, z.core.$strip>>>;
+    image: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
 }, z.core.$strip>;

package/dist/background/background.schema.js

@@ -1,10 +1,11 @@
 import {
   backgroundEntitySchema,
   langProfSchema
-} from "../chunk-SE7AZDR3.js";
-import "../chunk-3DZ74AKK.js";
-import "../chunk-NXSWH3AE.js";
-import "../chunk-NXR3BD2V.js";
+} from "../chunk-JRDPUDT5.js";
+import "../chunk-IN4M4X7P.js";
+import "../chunk-T26ZVCL5.js";
+import "../chunk-WPWOHGPI.js";
+import "../chunk-UA5KS2PL.js";
 export {
   backgroundEntitySchema,
   langProfSchema

package/dist/background/background.types.d.ts

@@ -2,6 +2,7 @@ import type { Ability, SkillSlug, Choice } from "@archivist-gg/dnd5e";
 import type { Edition } from "@archivist-gg/dnd5e/types/edition";
 import type { Resource } from "@archivist-gg/dnd5e/types/resource";
 import type { StartingEquipmentEntry } from "@archivist-gg/dnd5e/types/equipment-grant";
+import type { AdditionalSpellsEntry } from "@archivist-gg/dnd5e/schemas/entity-extras-schema";
 export type BackgroundToolProficiency = {
     kind: "fixed";
     items: string[];
@@ -49,4 +50,25 @@ export interface BackgroundEntity {
     origin_feat: string | null;
     suggested_characteristics: SuggestedCharacteristics | null;
     choices?: Choice[];
+    /** Converter/bundle extras declared by background.schema.ts §2.6; all optional, none read today. */
+    rendering_hint?: string;
+    has_fluff_images?: boolean;
+    /** 88 roll tables over 67 docs; `roll` is a STRING on every row ("1", "2-3"). Render is G3b's
+     *  (the 2026-09-02 G3 split; G3a renders no background tables). */
+    tables?: Array<{
+        name: string;
+        dice: string;
+        rows: Array<{
+            roll: string;
+            text: string;
+        }>;
+    }>;
+    additional_spells?: AdditionalSpellsEntry[];
+    /** The kind is CLOSED at the converter's only push site (background-mapper.ts). */
+    prerequisites?: Array<{
+        kind: "campaign";
+        slug: string;
+    }>;
+    /** One wikilink, or an array of them for the multi-fluff-image emit. */
+    image?: string | string[];
 }

package/dist/{chunk-4TIJKN6O.js → chunk-23LZLBJK.js}

@@ -26,7 +26,7 @@ var tabDeclSchema = z.object({
   label: z.string().min(1),
   renders: z.object({
     pool: z.string().min(1),
-    layout: z.enum(["spell-like", "blocks"]).optional()
+    layout: z.enum(["spell-like", "blocks", "dice-pool", "point-pool"]).optional()
   })
 });
 

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

@@ -1,3 +1,7 @@
+import {
+  imageField
+} from "./chunk-UA5KS2PL.js";
+
 // src/weapon/weapon.schema.ts
 import { z } from "zod";
 var conditionalPropertySchema = z.object({
@@ -31,7 +35,21 @@ var weaponEntitySchema = z.object({
   page: z.number().int().optional(),
   edition: editionEnum,
   entries: z.array(z.unknown()).optional(),
+  // Root extras the converter and the SRD bundle emit on more than one root (spec §5).
+  // Carrier counts measured on the G1b close census. `rendering_hint` is ALWAYS the empty
+  // string today, so `.min(1)` is forbidden here.
+  rendering_hint: z.string().optional(),
+  // 98
+  has_fluff: z.boolean().optional(),
+  // 1
+  has_fluff_images: z.boolean().optional(),
+  // 39
+  // Already `.optional()` at its source — never append a second one.
+  image: imageField,
+  // 0 today (images-OFF tree)
   raw: z.record(z.string(), z.unknown()).optional()
+  // `weapon :: value_rarity :: duplicated` (8) is deliberately NOT declared: it is
+  // converter-owned and stays a named expected residual (spec §10.3).
 }).loose();
 
 export {