@archivist-gg/dnd5e 0.3.19 → 0.3.26

package/dist/types/optional-feature.types.d.ts

@@ -4,13 +4,7 @@ import type { ActionCost, ResetTrigger, ResourceConsumption } from "./resource.j
 import type { Duration } from "../schemas/duration-schema.js";
 import type { Edition } from "./edition.js";
 import type { AdditionalSpellsEntry, ProgressionEntry } from "../schemas/entity-extras-schema.js";
-/**
- * Documentation-only union of the canonical SRD feature types. The
- * `feature_type` field is now an open string (see {@link OptionalFeatureEntity})
- * so homebrew categories parse; this union is kept purely as a reference list.
- */
-export type OptionalFeatureKind = "invocation" | "fighting_style" | "metamagic" | "maneuver" | "infusion" | "artificer_plan" | "pact_boon";
-/** A class/subclass named reference carried by a level prerequisite; mirrors namedRefSchema. */
+export type OptionalFeatureKind = "invocation" | "fighting_style" | "metamagic" | "maneuver" | "infusion" | "pact_boon";
 export type OptionalFeatureNamedRef = {
     name: string;
     source?: string;
@@ -46,7 +40,6 @@ export type OptionalFeaturePrerequisite = {
     entry?: string;
     entry_summary?: string;
 };
-/** ART-a (spec §4.2). */
 export interface FilterSpec {
     rarity: string[];
     types?: string[];
@@ -89,7 +82,6 @@ export interface InfuseItem {
         recharge_amount?: string;
     };
     action?: ActionCost;
-    /** ART-c1 (R-3 a): the Actions row's range ("Self"); absent draws no range. */
     range?: string;
 }
 export interface InfuseTarget {
@@ -121,53 +113,31 @@ export interface OptionalFeatureEntity {
     name: string;
     edition: Edition;
     source: string;
-    /** Open string category (e.g. "invocation"); see {@link OptionalFeatureKind} for canonical SRD values. */
     feature_type: string;
     description: string;
     prerequisites: OptionalFeaturePrerequisite[];
-    /** Wikilinks to classes/subclasses that can pick this option. */
     available_to: string[];
-    /** Mechanical effects mirrored on Feat — same shape. */
     effects: FeatureEffect[];
-    /** Optional action economy when the option grants an active ability. */
     action_cost?: ActionCost | null;
-    /** Optional uses tracker. */
     uses?: {
         max: number | string;
         recharge: ResetTrigger;
     } | null;
-    /** Resource cost to use this option (e.g. burn a Seal). */
     consumes?: ResourceConsumption | null;
-    /** How long the granted effect lasts (rendered as a label in Phase 2). */
     duration?: Duration | null;
-    /** Always-on marker; renders a "Passive" tag. */
     passive?: boolean;
-    /** Phase 3 activatable buffs: when true, the boon's effects fold only while its
-     *  slug is present in `Character.state.active_buffs` (toggled in the PoolTab). */
     activatable?: boolean;
-    /** Converter extras declared by optional-feature.schema.ts §2.5; all optional.
-     *  `rendering_hint` is the ONE of these whose VALUES are load-bearing (88 records carry a
-     *  real marker such as `dice-pool`); reading it is G4's row, declaring it is this one's. */
     rendering_hint?: string;
-    /** `band` = also drawn in the header strip. Absent/`tab` = the Resources tab only. */
     surface?: "band" | "tab";
     additional_spells?: AdditionalSpellsEntry[];
     is_class_feature_variant?: boolean;
     has_fluff_images?: boolean;
     feat_progression?: ProgressionEntry[];
     optionalfeature_progression?: ProgressionEntry[];
-    /** One wikilink, or an array of them for the multi-fluff-image emit. */
     image?: string | string[];
-    /** ART-a (spec §4.1): a pick is a COPY `<note slug>#<param>`; needs `options` and `item_choice`. */
     repeatable?: true;
-    /** `learn`: the param is the item's FULL slug (TCE); `create`: the param is a row key, the item chosen at Create (EFA). */
     item_choice?: "learn" | "create";
-    /** The table a copy's param must satisfy (spec §4.2). */
     options?: OptionRow[];
-    /** This member infuses an existing object; its effect is an item-vocabulary overlay (spec §4.2). */
     infuse?: InfuseBlock;
-    /** D2b-A (design §2.2 step 1): the member's OWN choices (Lessons of the First Ones' Origin feat, Superior Technique's
-     *  maneuver, Pact of the Tome's cantrips and rituals), in the same `Choice` vocabulary features and feats use. Absent,
-     *  the engine derives them from the raw keys the note already carries (`memberChoices`, `pc.member-choices.ts`). */
     choices?: Choice[];
 }

package/dist/types/resource.d.ts

@@ -1,5 +1,3 @@
-/** `either` = recovered by a short OR a long rest (R4-G3a §8.2; the 43 "short or
- *  long rest" rows). Kept in step with `resetTriggerEnum` in schemas/resource-schema.ts. */
 export type ResetTrigger = "short-rest" | "long-rest" | "either" | "dawn" | "dusk" | "turn" | "round" | "custom";
 export type ActionCost = "action" | "bonus-action" | "reaction" | "free" | "special";
 export interface ResourceDie {
@@ -13,17 +11,6 @@ export interface ResourceRecovery {
     action?: ActionCost;
     uses?: number;
     reset: ResetTrigger;
-    /** The recovery KIND; absent = `uses` (R4-G4 §7, UR2), applied by the RESOLVER
-     *  (pc/pc.resources.ts `resolveRecovery`) and never by a schema default, because
-     *  the sheet reads RAW entities. The CARRIERS, re-measured 2026-09-05 after R4-G4
-     *  T2b's regen shipped the bundle (this sentence was authored at T2, BEFORE that
-     *  regen, and said ZERO, which it no longer is): `grep -rl "restores:" --include='*.md'`
-     *  returns the TWO bundle Wizard notes (`SRD 2024/Classes/Wizard.md` and
-     *  `SRD 5e/Classes/Wizard.md`), whose Arcane Recovery rows T2b's overlay stamps
-     *  `spell-slots` and which §7.1 measured as the only spell-slot recoveries in shipped
-     *  data; the embedded `.compendium-bundle/index.json` carries the key on one line for
-     *  the same two rows; the converter corpus carries it on NO note. Kept in step with
-     *  `resourceSchema.recovery` in schemas/resource-schema.ts. */
     restores?: "uses" | "spell-slots";
 }
 export interface ResourceScaleStep {
@@ -41,24 +28,17 @@ export interface Resource {
     scales_at?: ResourceScaleStep[];
     die?: ResourceDie;
     reset: ResetTrigger;
-    /** Presentation, carried and never interpreted by the engine: which control draws this resource.
-     *  The renderer owns the hint → component table. */
     rendering_hint?: string;
-    /** `band` = also drawn in the header strip; absent = the Resources tab alone. */
     surface?: "band" | "tab";
     consumes?: ResourceConsumesLink;
     recovery?: ResourceRecovery[];
+    equivalent_ids?: string[];
 }
 export interface ResourceConsumption {
     source?: "resource" | "class-column" | "attack-dice" | "spell-slots";
     resource?: string;
     column?: string;
-    /** The MINIMUM spend when `amount_max` is present, otherwise the exact spend. */
     amount: number;
-    /** Upper bound of a RANGE spend (`amount` .. `amount_max`), int and positive.
-     *  DECLARED only in R4-G3a §9: zero emitted carriers, zero readers; spending a
-     *  range is G4's. Kept in step with `resourceConsumptionSchema` in
-     *  schemas/resource-schema.ts, whose refine is undefined-safe. */
     amount_max?: number;
     expend_condition?: "roll_succeeds" | "roll_fails" | "target_takes_damage" | "always";
     free_uses?: {

package/dist/types/selection-pool.d.ts

@@ -1,4 +1,3 @@
-/** ART-a (spec §4.5): the at-once counter of an item-bound pool; its defaults are applied at read (`poolActiveWords`). */
 export interface PoolActive {
     column: string;
     label: string;
@@ -7,8 +6,6 @@ export interface PoolActive {
     create_label?: string;
     create_verb?: string;
 }
-/** A (sub)class-declared selectable pool (e.g. Interdict Boons). The engine is
- *  generic: every game-specific string lives here in data, never in code. */
 export interface SelectionPool {
     id: string;
     label: string;
@@ -19,19 +16,14 @@ export interface SelectionPool {
             available_to: "self";
         };
     };
-    /** Pick count read from the owning class table column at the current level. `label` is the known-counter word,
-     *  read through `poolCountLabel` (absent reads "Known", ART-a spec §4.5). */
     count: {
         column: string;
         label?: string;
     };
     replaceable?: boolean;
-    /** ART-a (spec §4.5): the at-once counter (Infused Items, Magic Items). */
     active?: PoolActive;
-    /** ART-a (spec §4.5): a resource id the tab head shows when the pool spends none of its own. */
     head_resource?: string;
 }
-/** Subclass auto-grants that extend a named pool and do NOT count toward picks. */
 export interface PoolGrant {
     pool: string;
     grants: Array<{
@@ -39,24 +31,8 @@ export interface PoolGrant {
         at_level: number;
     }>;
 }
-/** Presentation hint for a data-declared tab. `dice-pool` / `point-pool` are DERIVED from the
- *  members' `rendering_hint` at resolve time onto `ResolvedPool.layout` (pc/pool-layout.ts), and that
- *  derivation is UNCONDITIONAL: it runs whether or not the declaration carries a `layout`. R4-G4 T5
- *  LANDED the precedence in the plugin: `TabsContainer`'s dynamic-pool-tab loop reads the AUTHORED
- *  value first, then `ResolvedPool.layout`. Since PT (spec §9) every pool tab draws one table and the value
- *  picks only the tab's HEAD (`poolPresentation`); `spell-like` and `blocks` still parse and are ignored.
- *  R4-G5 CLOSED that list, and NOT by adding values: `pool-selection` and `stance` never get a layout value
- *  (measured, spec §10: the three `stance`-hinted documents are field-identical to three unhinted siblings, and
- *  `pool-selection`'s meaning is delivered by `spell-like` plus the §5 head), and `granted-die-to-ally` is a
- *  PER-ROW affordance (`EntryAffordance` below), never a pool layout: mapping it here would bury four maneuvers
- *  under 39 on one vote of 43. This union keeps its four members and `RENDERING_HINT_LAYOUT` its two keys. */
 export type PoolLayout = "spell-like" | "blocks" | "dice-pool" | "point-pool";
-/** A PER-ENTRY affordance derived from ONE optional feature's own `rendering_hint` (R4-G5 §4.2.1). The sibling of
- *  `PoolLayout`, and deliberately not part of it: a layout is a POOL-level MAJORITY vote, so a hint carried by
- *  four of 43 maneuvers could never win one, and mapping it would be a monotone loss for the other 39. The table,
- *  the derivation and the caption live in `pc/pool-layout.ts`. ONE member today. */
 export type EntryAffordance = "granted-die";
-/** A data-declared tab that renders a pool (one generic pool-tab per declaration). */
 export interface TabDecl {
     id: string;
     label: string;

package/dist/weapon/weapon-mastery.d.ts

@@ -4,7 +4,6 @@ export declare const MASTERY: Record<string, {
     gist: string;
 }>;
 export declare function masteryLabel(slug: string): string | undefined;
-/** One-line effect gist for a mastery slug (or undefined for an unknown slug). */
 export declare function masteryGist(slug: string): string | undefined;
 export declare function masteryDerived(slug: string, abilityMod: number, proficiencyBonus: number): {
     label: string;

package/dist/weapon/weapon.classify.d.ts

@@ -1,15 +1,4 @@
 import type { WeaponEntity } from "./weapon.types.js";
-/** The two attack modes a weapon supports, derived from data the SRD pipeline
- *  actually preserves. Since dnd5e 0.3.13 the SRD data files the throwable
- *  MELEE weapons (dagger/spear/handaxe/javelin/light hammer/trident) as
- *  `*-melee`, but older SRD data, imported records and homebrew can still file
- *  them as `*-ranged` (by their thrown range), so the melee/ranged split is
- *  reconstructed here instead of trusted: a category-ranged weapon is PURE
- *  ranged only when it needs ammunition or loading, or is one of the two
- *  genuinely-ranged thrown weapons (dart, net: a closed SRD set; a homebrew
- *  weapon whose bare slug is exactly "dart"/"net" is force-classified pure
- *  ranged). Everything else category-ranged is a throwable melee weapon.
- *  `reach` is 5 ft., +5 with the reach property. */
 export interface WeaponRangeModes {
     melee: {
         reach: number;

package/dist/weapon/weapon.classify.js

@@ -1,7 +1 @@
-import {
-  classifyWeaponRange
-} from "../chunk-YDGMBMYI.js";
-import "../chunk-ZCTUYGNV.js";
-export {
-  classifyWeaponRange
-};
+import{classifyWeaponRange}from"../chunk-SEOASDO4.js";import"../chunk-63YJPWTM.js";export{classifyWeaponRange};

package/dist/weapon/weapon.codec.d.ts

@@ -1,12 +1,3 @@
 import type { DocCodec } from "@archivist-gg/core";
 import type { WeaponEntity } from "./weapon.types.js";
-/**
- * Normalizing codec (0c.1a). `parse` delegates to `parseWeapon`, which lifts
- * embedded-string `properties` (e.g. `versatile (1d10)`, `thrown (range
- * 20/60)`) into structured fields, validates against `weaponEntitySchema`
- * (injecting the `properties: []` default), and captures any unknown top-level
- * keys into `entity.raw`. `serialize` stays `yaml.dump` (the edit-save path
- * uses obsidian's separate serializer; gate (d) verifies `yaml.dump`
- * round-trips through `parseWeapon`).
- */
 export declare const weaponCodec: DocCodec<WeaponEntity>;

package/dist/weapon/weapon.codec.js

@@ -1,9 +1 @@
-import {
-  weaponCodec
-} from "../chunk-K5NJBTE2.js";
-import "../chunk-XCFC7LGF.js";
-import "../chunk-5GKJAUMX.js";
-import "../chunk-UA5KS2PL.js";
-export {
-  weaponCodec
-};
+import{weaponCodec}from"../chunk-4GN3GYMP.js";import"../chunk-BZ6BGGZS.js";import"../chunk-LJNT3PJP.js";import"../chunk-I26FHSI6.js";export{weaponCodec};

package/dist/weapon/weapon.parser.js

@@ -1,8 +1 @@
-import {
-  parseWeapon
-} from "../chunk-XCFC7LGF.js";
-import "../chunk-5GKJAUMX.js";
-import "../chunk-UA5KS2PL.js";
-export {
-  parseWeapon
-};
+import{parseWeapon}from"../chunk-BZ6BGGZS.js";import"../chunk-LJNT3PJP.js";import"../chunk-I26FHSI6.js";export{parseWeapon};

package/dist/weapon/weapon.schema.js

@@ -1,7 +1 @@
-import {
-  weaponEntitySchema
-} from "../chunk-5GKJAUMX.js";
-import "../chunk-UA5KS2PL.js";
-export {
-  weaponEntitySchema
-};
+import{weaponEntitySchema}from"../chunk-LJNT3PJP.js";import"../chunk-I26FHSI6.js";export{weaponEntitySchema};

package/dist/weapon/weapon.types.d.ts

@@ -34,13 +34,10 @@ export interface WeaponEntity {
     page?: number;
     edition: Edition;
     entries?: unknown[];
-    /** Carried as the empty string on every converter weapon carrier today (98). */
     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). */
     image?: z.infer<typeof imageField>;
     raw?: Record<string, unknown>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@archivist-gg/dnd5e",
-  "version": "0.3.19",
-  "license": "MIT AND CC-BY-4.0",
+  "version": "0.3.26",
+  "license": "SEE LICENSE IN LICENSE",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -18,7 +18,7 @@
     }
   },
   "dependencies": {
-    "@archivist-gg/core": "^0.1.0",
+    "@archivist-gg/core": "^0.1.1",
     "js-yaml": "^4.1.0",
     "zod": "^4.3.6"
   },

package/src/data-srd/ATTRIBUTION.md

@@ -1,2 +1,2 @@
-The files in this directory are **SRD 5.1 / 5.2 content under CC-BY-4.0, NOT MIT.**
+The files in this directory are **SRD 5.1 / 5.2 content under CC-BY-4.0, not under the package's own licence.**
 See [/LICENSES/SRD.md](../../LICENSES/SRD.md) for the required attribution.