@platonic-dice/dice 2.0.3 → 2.1.1

package/README.md

@@ -2,6 +2,8 @@
 
 Persistent dice objects with roll history and TypeScript support. This package builds on top of `@platonic-dice/core` and provides classes such as `Die` which maintain roll history, validators, and utilities for consuming applications.
 
+Version 2.1.0 adds support for `rollModTest()` - combining modifiers with test evaluation in a single method call.
+
 ## Installation
 
 ```bash
@@ -18,7 +20,12 @@ const { DieType } = require("@platonic-dice/core");
 
 const d20 = new Die(DieType.D20);
 console.log(d20.roll());
-console.log(d20.history.getAll());
+console.log(d20.history("normal"));
+
+// New in 2.1.0: rollModTest combines modifier and test evaluation
+const result = d20.rollModTest((n) => n + 5, { testType: "skill", target: 15 });
+console.log(`Modified result: ${result}`);
+console.log(d20.history("modifiedTest"));
 ```
 
 TypeScript:
@@ -29,6 +36,12 @@ import { DieType } from "@platonic-dice/core";
 
 const d20 = new Die(DieType.D20);
 console.log(d20.roll());
+
+// Apply modifier and evaluate against test conditions
+const result = d20.rollModTest((n) => n + 5, {
+  testType: "at_least",
+  target: 15,
+});
 ```
 
 ## Build

package/dist/components/die-history/internal/roll-record-manager/roll-record-manager.js

@@ -1,4 +1,4 @@
-import { isDieRollRecord, isModifiedDieRollRecord, isTargetDieRollRecord, stripTimestamp, } from "../roll-record-validator.js";
+import { isDieRollRecord, isModifiedDieRollRecord, isTargetDieRollRecord, isModifiedTestDieRollRecord, stripTimestamp, } from "../roll-record-validator.js";
 import { RollRecordStorage } from "./internal/index.js";
 /**
  * Default maximum number of roll records stored.
@@ -66,8 +66,9 @@ export class RollRecordManager {
         }
         if (!isDieRollRecord(record) &&
             !isModifiedDieRollRecord(record) &&
-            !isTargetDieRollRecord(record)) {
-            throw new TypeError("Record must be a valid DieRollRecord, ModifiedDieRollRecord, or TargetDieRollRecord");
+            !isTargetDieRollRecord(record) &&
+            !isModifiedTestDieRollRecord(record)) {
+            throw new TypeError("Record must be a valid DieRollRecord, ModifiedDieRollRecord, TestDieRollRecord, or ModifiedTestDieRollRecord");
         }
         this.storage.add(record);
     }

package/dist/components/die-history/internal/roll-record-validator.js

@@ -23,6 +23,15 @@ export function isTargetDieRollRecord(record) {
         typeof record.roll === "number" &&
         "outcome" in record &&
         Object.values(Outcome).includes(record.outcome) &&
+        record.timestamp instanceof Date &&
+        !("modified" in record));
+}
+export function isModifiedTestDieRollRecord(record) {
+    return (!!record &&
+        typeof record.roll === "number" &&
+        typeof record.modified === "number" &&
+        "outcome" in record &&
+        Object.values(Outcome).includes(record.outcome) &&
         record.timestamp instanceof Date);
 }
 /**
@@ -40,5 +49,6 @@ export default {
     isDieRollRecord,
     isModifiedDieRollRecord,
     isTargetDieRollRecord,
+    isModifiedTestDieRollRecord,
     stripTimestamp,
 };

package/dist/components/die-history/roll-record-factory.js

@@ -1,6 +1,5 @@
-import core from "@platonic-dice/core";
-const { RollType, roll: coreRoll, rollMod: coreRollMod, rollTest: coreRollTest, } = core;
-import { isDieRollRecord, isModifiedDieRollRecord, isTargetDieRollRecord, } from "./internal/index.js";
+import { RollType, roll as coreRoll, rollMod as coreRollMod, rollTest as coreRollTest, rollModTest as coreRollModTest, } from "@platonic-dice/core";
+import { isDieRollRecord, isModifiedDieRollRecord, isTargetDieRollRecord, isModifiedTestDieRollRecord, } from "./internal/index.js";
 /**
  * Default implementation that delegates to `@platonic-dice/core` and uses
  * the system clock. This keeps the public API simple and avoids DI.
@@ -52,5 +51,20 @@ export class RollRecordFactory {
         }
         return record;
     }
+    createModifiedTestRoll(dieType, modifier, testConditions, rollType, options) {
+        // Delegate to core rollModTest which combines modifier and test logic
+        const { base, modified, outcome } = coreRollModTest(dieType, modifier, testConditions, rollType, options);
+        const ts = new Date();
+        const record = {
+            roll: base,
+            modified,
+            outcome,
+            timestamp: ts,
+        };
+        if (!isModifiedTestDieRollRecord(record)) {
+            throw new Error("Factory produced invalid ModifiedTestDieRollRecord");
+        }
+        return record;
+    }
 }
 export default RollRecordFactory;

package/dist/die.js

@@ -164,6 +164,26 @@ export class Die {
         this.rolls.add(record);
         return record.roll;
     }
+    /**
+     * Perform a roll with a modifier and evaluate against test conditions.
+     * Combines rollMod and rollTest functionality.
+     *
+     * @param {RollModifierFunction | RollModifierInstance} modifier - Numeric or functional modifier applied to the base roll.
+     * @param {TestConditionsInstance | { testType: TestTypeValue; [k: string]: any }} testConditions - Test conditions (plain object or normalized `TestConditions` instance).
+     * @param {RollTypeValue} [rollType] - Optional roll mode (`RollType.Advantage` / `RollType.Disadvantage`).
+     * @param {{useNaturalCrits?: boolean}} [options] - Optional configuration for natural crits behavior.
+     * @returns {number} The modified numeric result.
+     * @throws {Error} If inputs are invalid (delegated to core).
+     * @example
+     * d20.rollModTest(n => n + 5, { testType: "at_least", target: 15 });
+     */
+    rollModTest(modifier, testConditions, rollType, options) {
+        const record = this.recordFactory.createModifiedTestRoll(this.typeValue, modifier, testConditions, rollType, options);
+        this.resultValue = record.modified;
+        this.rolls.setActiveKey(Die.MODIFIED_TEST_KEY);
+        this.rolls.add(record);
+        return record.modified;
+    }
     /**
      * Retrieve roll history for a given key.
      *
@@ -174,7 +194,7 @@ export class Die {
     /**
      * Retrieve roll history for a given key.
      *
-     * @param {string} [key=Die.NORMAL_KEY] - One of "normal" | "modifier" | "test".
+     * @param {string} [key=Die.NORMAL_KEY] - One of "normal" | "modifier" | "test" | "modifiedTest".
      * @param {boolean} [verbose=false] - Include timestamps when true.
      * @returns {Array} Array of roll records (timestamps included when verbose).
      */
@@ -225,3 +245,4 @@ export class Die {
 Die.NORMAL_KEY = "normal";
 Die.MODIFIER_KEY = "modifier";
 Die.TEST_KEY = "test";
+Die.MODIFIED_TEST_KEY = "modifiedTest";

package/dist/index.js

@@ -8,4 +8,4 @@ export { Die } from "./die.js";
 // Re-export core types and values that consumers will need
 // Note: Import from default due to CommonJS/ESM interop
 import core from "@platonic-dice/core";
-export const { DieType, RollType } = core;
+export const { DieType, RollType, rollModTest } = core;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platonic-dice/dice",
-  "version": "2.0.3",
+  "version": "2.1.1",
   "description": "Persistent dice objects with roll history and TypeScript support.",
   "type": "module",
   "main": "dist/index.js",
@@ -39,7 +39,7 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@platonic-dice/core": "^2.0.3"
+    "@platonic-dice/core": "^2.1.2"
   },
   "devDependencies": {
     "tsc-alias": "^1.8.16",