@archivist-gg/dnd5e 0.1.0

package/dist/types/feature.d.ts

@@ -0,0 +1,41 @@
+import type { Choice } from "./choice.js";
+import type { Resource, ResourceConsumption } from "./resource.js";
+import type { Attack } from "./attack.js";
+import type { FeatureEffect } from "./feature-effect.js";
+import type { Duration } from "../schemas/duration-schema.js";
+/**
+ * Recharge / per-day usage limits on a Feature (e.g. monster action).
+ *
+ * - `recharge_on_roll`: at the start of each turn, recharges on a d6 roll
+ *   ≥ `param`. Renders as "Recharge {param}-6" (or "Recharge 6" when param=6).
+ * - `per_day`: usable `param` times per day. Renders as "{param}/Day".
+ * - `per_short_rest` / `per_long_rest`: usable `param` times per rest.
+ */
+export interface FeatureRecharge {
+    type: "recharge_on_roll" | "per_day" | "per_short_rest" | "per_long_rest";
+    param: number;
+}
+export interface Feature {
+    id?: string;
+    name: string;
+    description?: string;
+    entries?: string[];
+    choices?: Choice[];
+    grants_resource?: string;
+    consumes?: ResourceConsumption;
+    attacks?: Attack[];
+    action?: "action" | "bonus-action" | "reaction" | "free" | "special";
+    trigger?: string;
+    dc_formula?: string;
+    effects?: FeatureEffect[];
+    sub_features?: Feature[];
+    resources?: Resource[];
+    recharge?: FeatureRecharge;
+    /** Phase 3 activatable buffs: when true, the feature's effects fold only while
+     *  its `id` is present in `Character.state.active_buffs` (toggled in the UI). */
+    activatable?: boolean;
+    /** Always-on marker; renders a "Passive" tag. */
+    passive?: boolean;
+    /** How long the buff lasts; rendered as a static label (no live countdown). */
+    duration?: Duration;
+}

package/dist/types/formula-context.d.ts

@@ -0,0 +1,7 @@
+import type { Abilities } from "./abilities.js";
+import type { EntityRegistry } from "@archivist-gg/core";
+export interface FormulaContext {
+    abilities: Abilities;
+    proficiencyBonus: number;
+    compendium?: EntityRegistry;
+}

package/dist/types/hp.d.ts

@@ -0,0 +1,4 @@
+export interface HP {
+    average: number;
+    formula?: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+export type { Abilities } from "./abilities.js";
+export type { FormulaContext } from "./formula-context.js";
+export type { AC } from "./ac.js";
+export type { HP } from "./hp.js";
+export type { Speed } from "./speed.js";
+export type { Feature, FeatureRecharge } from "./feature.js";
+export type { Choice, Ability, SkillSlug, FeatCategory } from "./choice.js";
+export type { Resource, ResourceDie, ResourceRecovery, ResourceConsumption, ResetTrigger, ActionCost } from "./resource.js";
+export type { Attack, AttackRange } from "./attack.js";
+export type { FeatureEffect } from "./feature-effect.js";

package/dist/types/item-conditions.types.d.ts

@@ -0,0 +1,63 @@
+import type { Ability } from "./choice.js";
+export type Tier1Condition = {
+    kind: "no_armor";
+} | {
+    kind: "no_shield";
+} | {
+    kind: "wielding_two_handed";
+} | {
+    kind: "is_class";
+    value: string;
+} | {
+    kind: "is_race";
+    value: string;
+} | {
+    kind: "is_subclass";
+    value: string;
+};
+export type Tier2Condition = {
+    kind: "vs_creature_type";
+    value: string;
+} | {
+    kind: "vs_attack_type";
+    value: "ranged" | "melee";
+} | {
+    kind: "on_attack_type";
+    value: "ranged" | "melee";
+} | {
+    kind: "with_weapon_property";
+    value: string;
+} | {
+    kind: "vs_spell_save";
+};
+export type Tier3Condition = {
+    kind: "lighting";
+    value: "dim" | "bright" | "daylight" | "darkness";
+} | {
+    kind: "underwater";
+} | {
+    kind: "movement_state";
+    value: "flying" | "swimming" | "climbing" | "mounted";
+};
+export type Tier4Condition = {
+    kind: "has_condition";
+    value: string;
+} | {
+    kind: "is_concentrating";
+} | {
+    kind: "bloodied";
+};
+export type FreeTextCondition = {
+    kind: "raw";
+    text: string;
+};
+export type AnyOfCondition = {
+    kind: "any_of";
+    conditions: Condition[];
+};
+export type Condition = Tier1Condition | Tier2Condition | Tier3Condition | Tier4Condition | FreeTextCondition | AnyOfCondition;
+export interface ConditionalBonus {
+    value: number;
+    when: Condition[];
+}
+export type BonusFieldPath = "ac" | "saving_throws" | "spell_attack" | "spell_save_dc" | "weapon_attack" | "weapon_damage" | `ability_scores.bonus.${Ability}` | "speed.walk" | "speed.fly" | "speed.swim" | "speed.climb";

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

@@ -0,0 +1,60 @@
+import type { FeatureEffect } from "./feature-effect.js";
+import type { ActionCost, ResetTrigger, ResourceConsumption } from "./resource.js";
+import type { Duration } from "../schemas/duration-schema.js";
+import type { Edition } from "./edition.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";
+export type OptionalFeaturePrerequisite = {
+    kind: "level";
+    min: number;
+} | {
+    kind: "spell-known";
+    spell: string;
+} | {
+    kind: "pact";
+    pact: "tome" | "blade" | "chain" | "talisman";
+} | {
+    kind: "class";
+    class: string;
+} | {
+    kind: "ability";
+    ability: "str" | "dex" | "con" | "int" | "wis" | "cha";
+    min: number;
+} | {
+    kind: "other";
+    detail: string;
+};
+export interface OptionalFeatureEntity {
+    slug: string;
+    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;
+}

package/dist/types/resource.d.ts

@@ -0,0 +1,44 @@
+export type ResetTrigger = "short-rest" | "long-rest" | "dawn" | "dusk" | "turn" | "round" | "custom";
+export type ActionCost = "action" | "bonus-action" | "reaction" | "free" | "special";
+export interface ResourceDie {
+    base: string;
+    scaling?: Record<string, string>;
+}
+export interface ResourceRecovery {
+    id: string;
+    name: string;
+    amount: number | string;
+    action?: ActionCost;
+    uses?: number;
+    reset: ResetTrigger;
+}
+export interface ResourceScaleStep {
+    level: number;
+    max: string;
+}
+export interface ResourceConsumesLink {
+    resource: string;
+    amount: number;
+}
+export interface Resource {
+    id: string;
+    name: string;
+    max_formula: string;
+    scales_at?: ResourceScaleStep[];
+    die?: ResourceDie;
+    reset: ResetTrigger;
+    consumes?: ResourceConsumesLink;
+    recovery?: ResourceRecovery[];
+}
+export interface ResourceConsumption {
+    source?: "resource" | "class-column" | "attack-dice";
+    resource?: string;
+    column?: string;
+    amount: number;
+    expend_condition?: "roll_succeeds" | "roll_fails" | "target_takes_damage" | "always";
+    free_uses?: {
+        amount: number;
+        reset: ResetTrigger;
+        state_key?: string;
+    };
+}

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

@@ -0,0 +1,37 @@
+/** 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;
+    source: {
+        entity_type: "optional-feature";
+        where: {
+            feature_type: string;
+            available_to: "self";
+        };
+    };
+    /** Pick count read from the owning class table column at the current level. */
+    count: {
+        column: string;
+    };
+    replaceable?: boolean;
+}
+/** Subclass auto-grants that extend a named pool and do NOT count toward picks. */
+export interface PoolGrant {
+    pool: string;
+    grants: Array<{
+        feature: string;
+        at_level: number;
+    }>;
+}
+/** Presentation hint for a data-declared tab. "text" reserved for later. */
+export type PoolLayout = "spell-like" | "blocks";
+/** A data-declared tab that renders a pool (one generic pool-tab per declaration). */
+export interface TabDecl {
+    id: string;
+    label: string;
+    renders: {
+        pool: string;
+        layout?: PoolLayout;
+    };
+}

package/dist/types/speed.d.ts

@@ -0,0 +1,8 @@
+export interface Speed {
+    walk?: number;
+    fly?: number;
+    swim?: number;
+    climb?: number;
+    burrow?: number;
+    hover?: boolean;
+}

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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,8 @@
+import {
+  weaponCodec
+} from "../chunk-5INR4NSL.js";
+import "../chunk-6NK2MUD3.js";
+import "../chunk-AFKTJXRA.js";
+export {
+  weaponCodec
+};

package/dist/weapon/weapon.entity-type.d.ts

@@ -0,0 +1,2 @@
+import type { EntityType } from "@archivist-gg/core";
+export declare const weaponEntityType: EntityType;

package/dist/weapon/weapon.parser.d.ts

@@ -0,0 +1,3 @@
+import type { WeaponEntity } from "./weapon.types.js";
+import { ParseResult } from "@archivist-gg/core";
+export declare function parseWeapon(source: string): ParseResult<WeaponEntity>;

package/dist/weapon/weapon.parser.js

@@ -0,0 +1,7 @@
+import {
+  parseWeapon
+} from "../chunk-6NK2MUD3.js";
+import "../chunk-AFKTJXRA.js";
+export {
+  parseWeapon
+};

package/dist/weapon/weapon.schema.d.ts

@@ -0,0 +1,34 @@
+import { z } from "zod";
+export declare const weaponEntitySchema: z.ZodObject<{
+    name: z.ZodString;
+    slug: z.ZodString;
+    category: z.ZodString;
+    damage: z.ZodObject<{
+        dice: z.ZodString;
+        type: z.ZodString;
+        versatile_dice: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    properties: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        kind: z.ZodLiteral<"conditional">;
+        uid: z.ZodString;
+        note: z.ZodString;
+    }, z.core.$strip>]>>>;
+    range: z.ZodOptional<z.ZodObject<{
+        normal: z.ZodNumber;
+        long: z.ZodNumber;
+    }, z.core.$strip>>;
+    reload: z.ZodOptional<z.ZodNumber>;
+    mastery: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    type_tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    ammo_type: z.ZodOptional<z.ZodString>;
+    weight: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    cost: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    edition: z.ZodEnum<{
+        2014: "2014";
+        2024: "2024";
+    }>;
+    entries: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    raw: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$loose>;

package/dist/weapon/weapon.schema.js

@@ -0,0 +1,6 @@
+import {
+  weaponEntitySchema
+} from "../chunk-AFKTJXRA.js";
+export {
+  weaponEntitySchema
+};

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

@@ -0,0 +1,36 @@
+import type { Edition } from "@archivist-gg/dnd5e/types/edition";
+export type WeaponCategory = "simple-melee" | "simple-ranged" | "martial-melee" | "martial-ranged" | "natural" | string;
+export type DamageType = "acid" | "bludgeoning" | "cold" | "fire" | "force" | "lightning" | "necrotic" | "piercing" | "poison" | "psychic" | "radiant" | "slashing" | "thunder";
+export type ConditionalProperty = {
+    kind: "conditional";
+    uid: string;
+    note: string;
+};
+export type WeaponProperty = "finesse" | "light" | "heavy" | "two_handed" | "reach" | "special" | "thrown" | "ammunition" | "versatile" | "loading" | "range" | ConditionalProperty;
+export type WeaponTypeTag = "sword" | "axe" | "bow" | "crossbow" | "club" | "dagger" | "firearm" | "hammer" | "lance" | "mace" | "net" | "polearm" | "rapier" | "spear" | "staff" | string;
+export interface WeaponEntity {
+    name: string;
+    slug: string;
+    category: WeaponCategory;
+    damage: {
+        dice: string;
+        type: DamageType | string;
+        versatile_dice?: string;
+    };
+    properties: WeaponProperty[];
+    range?: {
+        normal: number;
+        long: number;
+    };
+    reload?: number;
+    mastery?: string[];
+    type_tags?: WeaponTypeTag[];
+    ammo_type?: string;
+    weight?: number | string;
+    cost?: string;
+    source?: string;
+    page?: number;
+    edition: Edition;
+    entries?: unknown[];
+    raw?: Record<string, unknown>;
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@archivist-gg/dnd5e",
+  "version": "0.1.0",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    }
+  },
+  "dependencies": {
+    "@archivist-gg/core": "^0.1.0",
+    "js-yaml": "^4.1.0",
+    "zod": "^4.3.6"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "LICENSES/SRD.md",
+    "src/data-srd/ATTRIBUTION.md"
+  ]
+}

package/src/data-srd/ATTRIBUTION.md

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