@swrpg-online/dice 1.3.0 → 1.4.1

package/dist/diceFaces.d.ts

@@ -0,0 +1,17 @@
+import { DieFaceSymbols } from "./types";
+export declare const BOOST_DIE_FACES: Record<number, DieFaceSymbols>;
+export declare const SETBACK_DIE_FACES: Record<number, DieFaceSymbols>;
+export declare const ABILITY_DIE_FACES: Record<number, DieFaceSymbols>;
+export declare const DIFFICULTY_DIE_FACES: Record<number, DieFaceSymbols>;
+export declare const PROFICIENCY_DIE_FACES: Record<number, DieFaceSymbols>;
+export declare const CHALLENGE_DIE_FACES: Record<number, DieFaceSymbols>;
+export declare const FORCE_DIE_FACES: Record<number, DieFaceSymbols>;
+export declare const DICE_FACES: {
+    readonly boost: Record<number, DieFaceSymbols>;
+    readonly setback: Record<number, DieFaceSymbols>;
+    readonly ability: Record<number, DieFaceSymbols>;
+    readonly difficulty: Record<number, DieFaceSymbols>;
+    readonly proficiency: Record<number, DieFaceSymbols>;
+    readonly challenge: Record<number, DieFaceSymbols>;
+    readonly force: Record<number, DieFaceSymbols>;
+};

package/dist/diceFaces.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DICE_FACES = exports.FORCE_DIE_FACES = exports.CHALLENGE_DIE_FACES = exports.PROFICIENCY_DIE_FACES = exports.DIFFICULTY_DIE_FACES = exports.ABILITY_DIE_FACES = exports.SETBACK_DIE_FACES = exports.BOOST_DIE_FACES = void 0;
+exports.BOOST_DIE_FACES = {
+    1: {}, // Blank
+    2: {}, // Blank
+    3: { successes: 1 }, // (S)
+    4: { successes: 1, advantages: 1 }, // (S)(A)
+    5: { advantages: 2 }, // (A)(A)
+    6: { advantages: 1 }, // (A)
+};
+exports.SETBACK_DIE_FACES = {
+    1: {}, // Blank
+    2: {}, // Blank
+    3: { failures: 1 }, // (F)
+    4: { failures: 1 }, // (F)
+    5: { threats: 1 }, // (TH)
+    6: { threats: 1 }, // (TH)
+};
+exports.ABILITY_DIE_FACES = {
+    1: {}, // Blank
+    2: { successes: 1 }, // (S)
+    3: { successes: 1 }, // (S)
+    4: { successes: 2 }, // (S)(S)
+    5: { advantages: 1 }, // (A)
+    6: { advantages: 1 }, // (A)
+    7: { successes: 1, advantages: 1 }, // (S)(A)
+    8: { advantages: 2 }, // (A)(A)
+};
+exports.DIFFICULTY_DIE_FACES = {
+    1: {}, // Blank
+    2: { failures: 1 }, // (F)
+    3: { failures: 2 }, // (F)(F)
+    4: { threats: 1 }, // (TH)
+    5: { threats: 1 }, // (TH)
+    6: { threats: 1 }, // (TH)
+    7: { threats: 2 }, // (TH)(TH)
+    8: { failures: 1, threats: 1 }, // (F)(TH)
+};
+exports.PROFICIENCY_DIE_FACES = {
+    1: {}, // Blank
+    2: { successes: 1 }, // (S)
+    3: { successes: 1 }, // (S)
+    4: { successes: 2 }, // (S)(S)
+    5: { successes: 2 }, // (S)(S)
+    6: { advantages: 1 }, // (A)
+    7: { successes: 1, advantages: 1 }, // (S)(A)
+    8: { successes: 1, advantages: 1 }, // (S)(A)
+    9: { successes: 1, advantages: 1 }, // (S)(A)
+    10: { advantages: 2 }, // (A)(A)
+    11: { successes: 1, advantages: 1 }, // (S)(A)
+    12: { triumphs: 1 }, // (TR) - Triumph also counts as Success
+};
+exports.CHALLENGE_DIE_FACES = {
+    1: {}, // Blank
+    2: { failures: 1 }, // (F)
+    3: { failures: 1 }, // (F)
+    4: { failures: 2 }, // (F)(F)
+    5: { failures: 2 }, // (F)(F)
+    6: { threats: 1 }, // (TH)
+    7: { threats: 1 }, // (TH)
+    8: { failures: 1, threats: 1 }, // (F)(TH)
+    9: { failures: 1, threats: 1 }, // (F)(TH)
+    10: { threats: 2 }, // (TH)(TH)
+    11: { threats: 2 }, // (TH)(TH)
+    12: { despairs: 1 }, // (D) - Despair also counts as Failure
+};
+exports.FORCE_DIE_FACES = {
+    1: { darkSide: 1 }, // (DS)
+    2: { darkSide: 1 }, // (DS)
+    3: { darkSide: 1 }, // (DS)
+    4: { darkSide: 1 }, // (DS)
+    5: { darkSide: 1 }, // (DS)
+    6: { darkSide: 1 }, // (DS)
+    7: { darkSide: 2 }, // (DS)(DS)
+    8: { lightSide: 1 }, // (LS)
+    9: { lightSide: 1 }, // (LS)
+    10: { lightSide: 2 }, // (LS)(LS)
+    11: { lightSide: 2 }, // (LS)(LS)
+    12: { lightSide: 2 }, // (LS)(LS)
+};
+exports.DICE_FACES = {
+    boost: exports.BOOST_DIE_FACES,
+    setback: exports.SETBACK_DIE_FACES,
+    ability: exports.ABILITY_DIE_FACES,
+    difficulty: exports.DIFFICULTY_DIE_FACES,
+    proficiency: exports.PROFICIENCY_DIE_FACES,
+    challenge: exports.CHALLENGE_DIE_FACES,
+    force: exports.FORCE_DIE_FACES,
+};

package/dist/index.d.ts

@@ -1,3 +1,6 @@
 export { roll } from "./dice";
-export type { DicePool, RollResult } from "./types";
-export { createSkillCheck, createCombatCheck, createOpposedCheck, createDifficultyPool, } from "./pools";
+export type { DicePool, RollResult, DiceResult, RollOptions, DieFaceSymbols, BoostDieFace, SetbackDieFace, AbilityDieFace, DifficultyDieFace, ProficiencyDieFace, ChallengeDieFace, ForceDieFace, Symbol, } from "./types";
+export { SYMBOLS } from "./types";
+export { BOOST_DIE_FACES, SETBACK_DIE_FACES, ABILITY_DIE_FACES, DIFFICULTY_DIE_FACES, PROFICIENCY_DIE_FACES, CHALLENGE_DIE_FACES, FORCE_DIE_FACES, DICE_FACES, } from "./diceFaces";
+export { createSkillCheck, createCombatCheck, createOpposedCheck, createDifficultyPool, applyTalentModifiers, } from "./pools";
+export type { PoolModifiers } from "./pools";

package/dist/index.js

@@ -1,10 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDifficultyPool = exports.createOpposedCheck = exports.createCombatCheck = exports.createSkillCheck = exports.roll = void 0;
+exports.applyTalentModifiers = exports.createDifficultyPool = exports.createOpposedCheck = exports.createCombatCheck = exports.createSkillCheck = exports.DICE_FACES = exports.FORCE_DIE_FACES = exports.CHALLENGE_DIE_FACES = exports.PROFICIENCY_DIE_FACES = exports.DIFFICULTY_DIE_FACES = exports.ABILITY_DIE_FACES = exports.SETBACK_DIE_FACES = exports.BOOST_DIE_FACES = exports.SYMBOLS = exports.roll = void 0;
 var dice_1 = require("./dice");
 Object.defineProperty(exports, "roll", { enumerable: true, get: function () { return dice_1.roll; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "SYMBOLS", { enumerable: true, get: function () { return types_1.SYMBOLS; } });
+var diceFaces_1 = require("./diceFaces");
+Object.defineProperty(exports, "BOOST_DIE_FACES", { enumerable: true, get: function () { return diceFaces_1.BOOST_DIE_FACES; } });
+Object.defineProperty(exports, "SETBACK_DIE_FACES", { enumerable: true, get: function () { return diceFaces_1.SETBACK_DIE_FACES; } });
+Object.defineProperty(exports, "ABILITY_DIE_FACES", { enumerable: true, get: function () { return diceFaces_1.ABILITY_DIE_FACES; } });
+Object.defineProperty(exports, "DIFFICULTY_DIE_FACES", { enumerable: true, get: function () { return diceFaces_1.DIFFICULTY_DIE_FACES; } });
+Object.defineProperty(exports, "PROFICIENCY_DIE_FACES", { enumerable: true, get: function () { return diceFaces_1.PROFICIENCY_DIE_FACES; } });
+Object.defineProperty(exports, "CHALLENGE_DIE_FACES", { enumerable: true, get: function () { return diceFaces_1.CHALLENGE_DIE_FACES; } });
+Object.defineProperty(exports, "FORCE_DIE_FACES", { enumerable: true, get: function () { return diceFaces_1.FORCE_DIE_FACES; } });
+Object.defineProperty(exports, "DICE_FACES", { enumerable: true, get: function () { return diceFaces_1.DICE_FACES; } });
 var pools_1 = require("./pools");
 Object.defineProperty(exports, "createSkillCheck", { enumerable: true, get: function () { return pools_1.createSkillCheck; } });
 Object.defineProperty(exports, "createCombatCheck", { enumerable: true, get: function () { return pools_1.createCombatCheck; } });
 Object.defineProperty(exports, "createOpposedCheck", { enumerable: true, get: function () { return pools_1.createOpposedCheck; } });
 Object.defineProperty(exports, "createDifficultyPool", { enumerable: true, get: function () { return pools_1.createDifficultyPool; } });
+Object.defineProperty(exports, "applyTalentModifiers", { enumerable: true, get: function () { return pools_1.applyTalentModifiers; } });

package/dist/pools.d.ts

@@ -1,32 +1,59 @@
 import { DicePool } from "./types";
+/**
+ * Options for applying talent or equipment modifiers to a dice pool
+ */
+export type PoolModifiers = {
+    automaticSuccesses?: number;
+    automaticFailures?: number;
+    automaticAdvantages?: number;
+    automaticThreats?: number;
+    automaticTriumphs?: number;
+    automaticDespairs?: number;
+    upgradeAbility?: number;
+    upgradeDifficulty?: number;
+    downgradeProficiency?: number;
+    downgradeChallenge?: number;
+};
 /**
  * Creates a basic skill check dice pool
  * @param ability Number of ability (green) dice
  * @param proficiency Number of proficiency (yellow) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for a basic skill check
  */
-export declare const createSkillCheck: (ability: number, proficiency: number) => DicePool;
+export declare const createSkillCheck: (ability: number, proficiency: number, modifiers?: PoolModifiers) => DicePool;
 /**
  * Creates a combat check dice pool with optional boost die
  * @param ability Number of ability (green) dice
  * @param proficiency Number of proficiency (yellow) dice
  * @param boost Number of boost (blue) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for a combat check
  */
-export declare const createCombatCheck: (ability: number, proficiency: number, boost?: number) => DicePool;
+export declare const createCombatCheck: (ability: number, proficiency: number, boost?: number, modifiers?: PoolModifiers) => DicePool;
 /**
  * Creates an opposed check dice pool
  * @param ability Number of ability (green) dice
  * @param proficiency Number of proficiency (yellow) dice
  * @param difficulty Number of difficulty (purple) dice
  * @param challenge Number of challenge (red) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for an opposed check
  */
-export declare const createOpposedCheck: (ability: number, proficiency: number, difficulty: number, challenge?: number) => DicePool;
+export declare const createOpposedCheck: (ability: number, proficiency: number, difficulty: number, challenge?: number, modifiers?: PoolModifiers) => DicePool;
 /**
  * Creates a difficulty check dice pool
  * @param difficulty Number of difficulty (purple) dice
  * @param challenge Number of challenge (red) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for a pure difficulty check
  */
-export declare const createDifficultyPool: (difficulty: number, challenge?: number) => DicePool;
+export declare const createDifficultyPool: (difficulty: number, challenge?: number, modifiers?: PoolModifiers) => DicePool;
+/**
+ * Applies talent modifiers to an existing dice pool
+ * Common use case for talents that add automatic advantages, successes, or upgrade dice
+ * @param pool The base dice pool
+ * @param modifiers The modifiers to apply
+ * @returns A new dice pool with modifiers applied
+ */
+export declare const applyTalentModifiers: (pool: DicePool, modifiers: PoolModifiers) => DicePool;

package/dist/pools.js

@@ -1,15 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDifficultyPool = exports.createOpposedCheck = exports.createCombatCheck = exports.createSkillCheck = void 0;
+exports.applyTalentModifiers = exports.createDifficultyPool = exports.createOpposedCheck = exports.createCombatCheck = exports.createSkillCheck = void 0;
 /**
  * Creates a basic skill check dice pool
  * @param ability Number of ability (green) dice
  * @param proficiency Number of proficiency (yellow) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for a basic skill check
  */
-const createSkillCheck = (ability, proficiency) => ({
+const createSkillCheck = (ability, proficiency, modifiers) => ({
     abilityDice: Math.max(0, ability),
     proficiencyDice: Math.max(0, proficiency),
+    ...modifiers,
 });
 exports.createSkillCheck = createSkillCheck;
 /**
@@ -17,12 +19,14 @@ exports.createSkillCheck = createSkillCheck;
  * @param ability Number of ability (green) dice
  * @param proficiency Number of proficiency (yellow) dice
  * @param boost Number of boost (blue) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for a combat check
  */
-const createCombatCheck = (ability, proficiency, boost = 0) => ({
+const createCombatCheck = (ability, proficiency, boost = 0, modifiers) => ({
     abilityDice: Math.max(0, ability),
     proficiencyDice: Math.max(0, proficiency),
     boostDice: Math.max(0, boost),
+    ...modifiers,
 });
 exports.createCombatCheck = createCombatCheck;
 /**
@@ -31,23 +35,48 @@ exports.createCombatCheck = createCombatCheck;
  * @param proficiency Number of proficiency (yellow) dice
  * @param difficulty Number of difficulty (purple) dice
  * @param challenge Number of challenge (red) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for an opposed check
  */
-const createOpposedCheck = (ability, proficiency, difficulty, challenge = 0) => ({
+const createOpposedCheck = (ability, proficiency, difficulty, challenge = 0, modifiers) => ({
     abilityDice: Math.max(0, ability),
     proficiencyDice: Math.max(0, proficiency),
     difficultyDice: Math.max(0, difficulty),
     challengeDice: Math.max(0, challenge),
+    ...modifiers,
 });
 exports.createOpposedCheck = createOpposedCheck;
 /**
  * Creates a difficulty check dice pool
  * @param difficulty Number of difficulty (purple) dice
  * @param challenge Number of challenge (red) dice
+ * @param modifiers Optional modifiers from talents, equipment, etc.
  * @returns DicePool configured for a pure difficulty check
  */
-const createDifficultyPool = (difficulty, challenge = 0) => ({
+const createDifficultyPool = (difficulty, challenge = 0, modifiers) => ({
     difficultyDice: Math.max(0, difficulty),
     challengeDice: Math.max(0, challenge),
+    ...modifiers,
 });
 exports.createDifficultyPool = createDifficultyPool;
+/**
+ * Applies talent modifiers to an existing dice pool
+ * Common use case for talents that add automatic advantages, successes, or upgrade dice
+ * @param pool The base dice pool
+ * @param modifiers The modifiers to apply
+ * @returns A new dice pool with modifiers applied
+ */
+const applyTalentModifiers = (pool, modifiers) => ({
+    ...pool,
+    automaticSuccesses: (pool.automaticSuccesses || 0) + (modifiers.automaticSuccesses || 0),
+    automaticFailures: (pool.automaticFailures || 0) + (modifiers.automaticFailures || 0),
+    automaticAdvantages: (pool.automaticAdvantages || 0) + (modifiers.automaticAdvantages || 0),
+    automaticThreats: (pool.automaticThreats || 0) + (modifiers.automaticThreats || 0),
+    automaticTriumphs: (pool.automaticTriumphs || 0) + (modifiers.automaticTriumphs || 0),
+    automaticDespairs: (pool.automaticDespairs || 0) + (modifiers.automaticDespairs || 0),
+    upgradeAbility: (pool.upgradeAbility || 0) + (modifiers.upgradeAbility || 0),
+    upgradeDifficulty: (pool.upgradeDifficulty || 0) + (modifiers.upgradeDifficulty || 0),
+    downgradeProficiency: (pool.downgradeProficiency || 0) + (modifiers.downgradeProficiency || 0),
+    downgradeChallenge: (pool.downgradeChallenge || 0) + (modifiers.downgradeChallenge || 0),
+});
+exports.applyTalentModifiers = applyTalentModifiers;

package/dist/types.d.ts

@@ -6,6 +6,18 @@ export type DicePool = {
     difficultyDice?: number;
     challengeDice?: number;
     forceDice?: number;
+    automaticSuccesses?: number;
+    automaticFailures?: number;
+    automaticAdvantages?: number;
+    automaticThreats?: number;
+    automaticTriumphs?: number;
+    automaticDespairs?: number;
+    automaticLightSide?: number;
+    automaticDarkSide?: number;
+    upgradeAbility?: number;
+    upgradeDifficulty?: number;
+    downgradeProficiency?: number;
+    downgradeChallenge?: number;
 };
 export type DiceResult = {
     successes: number;
@@ -39,6 +51,23 @@ export declare const SYMBOLS: {
     readonly DARK: "DARK";
 };
 export type Symbol = keyof typeof SYMBOLS;
+export type DieFaceSymbols = {
+    successes?: number;
+    failures?: number;
+    advantages?: number;
+    threats?: number;
+    triumphs?: number;
+    despairs?: number;
+    lightSide?: number;
+    darkSide?: number;
+};
+export type BoostDieFace = 1 | 2 | 3 | 4 | 5 | 6;
+export type SetbackDieFace = 1 | 2 | 3 | 4 | 5 | 6;
+export type AbilityDieFace = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+export type DifficultyDieFace = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+export type ProficiencyDieFace = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+export type ChallengeDieFace = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+export type ForceDieFace = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
 export type RollOptions = {
     hints?: boolean;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swrpg-online/dice",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "A TypeScript library that creates dice rolls using the narrative dice system for the Star Wars Roleplaying Game by Fantasy Flight Games and Edge Studio.",
   "keywords": [
     "swrpg",
@@ -81,7 +81,7 @@
     "rollup": "^2.79.2",
     "rollup-plugin-terser": "^7.0.2",
     "semantic-release": "^24.2.0",
-    "ts-jest": "^29.4.1",
+    "ts-jest": "^29.4.4",
     "tslib": "^2.8.1",
     "typescript": "^5.7.2"
   },