poker-extval 3.3.4 → 3.4.0

package/README.md

@@ -451,7 +451,7 @@ The test suite includes 700+ tests covering:
 
 ## API Reference
 
-### `evaluateHand(cards, strict, holeCards)`
+### `evaluateHand(cards, strict, holeCards, villainRange)`
 
 Main function to evaluate poker hands.
 
@@ -459,6 +459,7 @@ Main function to evaluate poker hands.
 - `cards` (string[]): Array of 5 or more card strings
 - `strict` (boolean, optional): If `true`, only the strongest made hand and stronger draws are marked. If `false`, all applicable hand types are marked (default: `true`).
 - `holeCards` (string[] | null, optional): Exactly 2 cards identifying the player's hole cards, both of which must appear in `cards`. Required for the overcard categorizations; without it those properties are always `false` (default: `null`).
+- `villainRange` (string[] | null, optional): Villain hands as exact combos (`'AhKd'`) or shorthand (`'QQ'`, `'AKs'`, `'AKo'`, `'AK'`, `'TT+'`, `'ATs+'`, `'ATo+'`, `'AT+'`). When supplied, each evaluation gets a `villainRange` property; see [Villain Range Blockers](#villain-range-blockers) (default: `null`).
 
 **Returns:**
 - Object mapping sorted hand strings to evaluation objects
@@ -471,7 +472,7 @@ Main function to evaluate poker hands.
 #### Constructor
 
 ```javascript
-new HandEvaluator(cards, strict, holeCards)
+new HandEvaluator(cards, strict, holeCards, villainRange)
 ```
 
 Creates a new HandEvaluator instance.
@@ -480,6 +481,7 @@ Creates a new HandEvaluator instance.
 - `cards` (string[]): Array of 5 or more card strings
 - `strict` (boolean, optional): If `true`, only the strongest made hand and stronger draws are marked. If `false`, all applicable hand types are marked (default: `true`).
 - `holeCards` (string[] | null, optional): Exactly 2 cards identifying the player's hole cards, both of which must appear in `cards`. Required for the overcard categorizations (default: `null`).
+- `villainRange` (string[] | null, optional): Villain hands as exact combos (`'AhKd'`) or shorthand (`'QQ'`, `'AKs'`, `'AKo'`, `'AK'`, `'TT+'`, `'ATs+'`, `'ATo+'`, `'AT+'`). When supplied, each evaluation gets a `villainRange` property; see [Villain Range Blockers](#villain-range-blockers) (default: `null`).
 
 **Properties:**
 - `evaluation` - Object mapping sorted hand strings to evaluation objects (same format as `evaluateHand()` return value)
@@ -487,6 +489,29 @@ Creates a new HandEvaluator instance.
 - `strict` - Boolean indicating whether strict mode is enabled
 - `holeCards` - Array of the 2 hole cards, or `null` if none were supplied
 
+### Villain Range Blockers
+
+Pass a villain range as the fourth argument to see which of its combos the known cards rule out:
+
+```javascript
+const board = ['Kh', '8d', '4c'];
+const holeCards = ['Ah', 'Js'];
+const result = evaluateHand([...board, ...holeCards], true, holeCards, ['AKs', 'QQ', 'JsTs']);
+const { villainRange } = Object.values(result)[0];
+
+villainRange.allBlocks;
+// { unblocked: ['AsKs', 'AdKd', 'AcKc', 'QsQh', 'QsQd', 'QsQc', 'QhQd', 'QhQc', 'QdQc'],
+//   blocked:   ['AhKh', 'JsTs'] }
+```
+
+The result has three views, each `{ unblocked: [], blocked: [] }` of exact combos:
+
+- `boardBlocks` - blocked by a board card (every card in `cards` that is not a hole card)
+- `heroBlocks` - blocked by one of the hole cards
+- `allBlocks` - blocked by any known card; `unblocked` here is what villain can actually hold
+
+Shorthand is expanded to combos, so a partly blocked entry such as `AKs` is split across both lists. Combos are written high rank first (`'AhKd'`, and `'QsQh'` for pairs with suits ordered s, h, d, c), duplicates are removed, and input order is kept. Without `holeCards`, every card is treated as board, so `heroBlocks` blocks nothing. In non-strict mode every combination carries the same `villainRange`. The property is omitted when no range is supplied, and an invalid entry throws.
+
 **Note**: All internal methods are private. Use the `evaluation` property to access evaluation results.
 
 ## Releasing

package/evaluator.js

@@ -73,9 +73,14 @@ class HandEvaluator {
    * @param {string[]|null} [holeCards=null] - Optional array of exactly 2 cards identifying the player's
    *   hole cards. Required for the overcard categorizations (isOvercard, isTwoOvercards, etc.); without it
    *   those properties are always false. Both cards must be present in `cards`.
+   * @param {string[]|null} [villainRange=null] - Optional array of villain hands, as exact combos ('AhKd') or
+   *   shorthand ('QQ', 'AKs', 'AKo', 'AK', 'TT+', 'ATs+', 'ATo+', 'AT+'). When supplied, every evaluation
+   *   gets a `villainRange` property listing which combos the known cards block (see #classifyVillainRange).
+   * @param {string[]|null} [originalCards=null] - Internal: the full hand when evaluating one 5-card combination
    * @throws {Error} If cards is not an array, has fewer than 5 cards, contains invalid format,
    *   invalid rank, invalid suit, or duplicate cards
    * @throws {Error} If holeCards is provided but is not an array of exactly 2 distinct cards drawn from `cards`
+   * @throws {Error} If villainRange is provided but is not an array of valid combos or shorthand
    * @example
    * const evaluator = new HandEvaluator(['As', 'Ks', 'Qs', 'Js', 'Ts']);
    * @example
@@ -88,7 +93,7 @@ class HandEvaluator {
    * // With hole cards - enables overcard categorization
    * const withHoleCards = new HandEvaluator(['Ks', 'Qh', '8d', '3c', 'Ad', 'Jh'], true, ['Ad', 'Jh']);
    */
-  constructor(cards, strict = true, holeCards = null, originalCards = null) {
+  constructor(cards, strict = true, holeCards = null, villainRange = null, originalCards = null) {
     this.#validateCards(cards);
     // Copy so that in-place sorting during evaluation never reorders the caller's array
     this.cards = [...cards];
@@ -100,7 +105,117 @@ class HandEvaluator {
       this.#validateHoleCards(holeCards, this.originalCards || cards);
       this.holeCards = holeCards;
     }
+    const villainCombos = villainRange === null || villainRange === undefined ? null : this.#parseVillainRange(villainRange);
     this.evaluation = this.#evaluateAllCombinations();
+    if (villainCombos) {
+      const classification = this.#classifyVillainRange(villainCombos);
+      for (const evaluation of Object.values(this.evaluation)) evaluation.villainRange = classification;
+    }
+  }
+
+  // ==================== VILLAIN RANGE ====================
+
+  /**
+   * Expands a villain range into exact two-card combos, in input order and without duplicates.
+   * Each combo is written high rank first, with suits ordered s, h, d, c for pairs (e.g. 'AhKd', 'QsQh').
+   *
+   * Accepted entries:
+   * - Exact combo: 'AhKd' (either card order)
+   * - Pair: 'QQ' (6 combos); 'TT+' adds every higher pair
+   * - Suited: 'AKs' (4 combos); offsuit: 'AKo' (12 combos); either: 'AK' (16 combos)
+   * - Plus forms keep the first rank and raise the second up to one below it: 'ATs+' is ATs, AJs, AQs, AKs
+   *
+   * @private
+   * @param {string[]} villainRange - Range entries to expand
+   * @returns {string[]} Exact combos
+   * @throws {Error} If villainRange is not an array or an entry is not a valid combo or shorthand
+   */
+  #parseVillainRange(villainRange) {
+    if (!Array.isArray(villainRange)) {
+      throw new Error('Villain range must be an array');
+    }
+    const ranks = 'AKQJT98765432';
+    const suits = 'shdc';
+    const combos = [];
+    const seen = new Set();
+    const add = (first, second) => {
+      // High rank first; for equal ranks, order suits s, h, d, c
+      const order = c => ranks.indexOf(c[0]) * 4 + suits.indexOf(c[1]);
+      const [a, b] = order(first) <= order(second) ? [first, second] : [second, first];
+      if (!seen.has(a + b)) {
+        seen.add(a + b);
+        combos.push(a + b);
+      }
+    };
+    const addRanks = (high, low, type) => {
+      for (const s1 of suits) {
+        for (const s2 of suits) {
+          if (high === low ? suits.indexOf(s2) <= suits.indexOf(s1) : (type === 's' && s1 !== s2) || (type === 'o' && s1 === s2)) continue;
+          add(high + s1, low + s2);
+        }
+      }
+    };
+
+    villainRange.forEach((entry, i) => {
+      const invalid = () => new Error(`Invalid villain range entry at index ${i}: "${entry}"`);
+      if (typeof entry !== 'string') throw invalid();
+
+      const exact = entry.match(/^([AKQJT2-9])([shdc])([AKQJT2-9])([shdc])$/);
+      if (exact) {
+        const [first, second] = [exact[1] + exact[2], exact[3] + exact[4]];
+        if (first === second) throw invalid();
+        add(first, second);
+        return;
+      }
+
+      const shorthand = entry.match(/^([AKQJT2-9])([AKQJT2-9])([so]?)(\+?)$/);
+      if (!shorthand) throw invalid();
+      const [, r1, r2, type, plus] = shorthand;
+      const [high, low] = ranks.indexOf(r1) <= ranks.indexOf(r2) ? [r1, r2] : [r2, r1];
+      if (high === low) {
+        if (type) throw invalid();
+        const lows = plus ? ranks.slice(0, ranks.indexOf(high) + 1) : high;
+        for (const rank of lows) addRanks(rank, rank);
+        return;
+      }
+      const lows = plus ? ranks.slice(ranks.indexOf(high) + 1, ranks.indexOf(low) + 1) : low;
+      for (const rank of lows) addRanks(high, rank, type);
+    });
+    return combos;
+  }
+
+  /**
+   * Splits villain combos by which known cards block them. A combo is blocked when it shares a
+   * card with the blockers, so villain cannot hold it.
+   *
+   * - boardBlocks: blocked by the board (every card that is not a hole card)
+   * - heroBlocks: blocked by the hole cards (always unblocked without hole cards)
+   * - allBlocks: blocked by any known card
+   *
+   * Without hole cards every card passed is treated as board.
+   *
+   * @private
+   * @param {string[]} combos - Exact combos from #parseVillainRange
+   * @returns {{boardBlocks: Object, heroBlocks: Object, allBlocks: Object}} Each with `unblocked` and `blocked` arrays
+   */
+  #classifyVillainRange(combos) {
+    const fullHand = this.originalCards || this.cards;
+    const heroCards = new Set(this.holeCards || []);
+    const boardCards = new Set(fullHand.filter(c => !heroCards.has(c)));
+    const allCards = new Set(fullHand);
+    const split = blockers => {
+      const result = { unblocked: [], blocked: [] };
+      for (const combo of combos) {
+        const isBlocked = blockers.has(combo.slice(0, 2)) || blockers.has(combo.slice(2));
+        result[isBlocked ? 'blocked' : 'unblocked'].push(combo);
+      }
+      return result;
+    };
+    return {
+      boardBlocks: split(boardCards),
+      heroBlocks: split(heroCards),
+      allBlocks: split(allCards)
+    };
   }
 
   /**
@@ -296,6 +411,9 @@ class HandEvaluator {
     this.#isOpenEndedStraightDraw();
     this.#isInsideStraightDraw();
     this.#isStraightDraw();
+    // Always set the wheel flags; the standard draw checks above only evaluate them as a fallback
+    this.#isOpenEndedStraightDrawWheel();
+    this.#isInsideStraightDrawWheel();
     this.#isComboDraw();
     this.#clearDrawsForStreet();
     this.#isUnderPair();
@@ -371,9 +489,7 @@ class HandEvaluator {
     
     // Filter draws: made flush or stronger cannot have straight draws
     if (strongest >= 6) {
-      evaluation.isStraightDraw = false;
-      evaluation.isOpenEndedStraightDraw = false;
-      evaluation.isInsideStraightDraw = false;
+      for (const draw of STRAIGHT_DRAW_PROPERTIES) evaluation[draw] = false;
     }
   }
 
@@ -522,7 +638,7 @@ class HandEvaluator {
     const result = {};
     for (const combination of combinations) {
       const key = this.#formatHandKey(combination);
-      const tempEvaluator = new HandEvaluator(combination, this.strict, this.holeCards, this.originalCards);
+      const tempEvaluator = new HandEvaluator(combination, this.strict, this.holeCards, null, this.originalCards);
       const evaluationKey = Object.keys(tempEvaluator.evaluation)[0];
       result[key] = tempEvaluator.evaluation[evaluationKey];
     }
@@ -2111,10 +2227,13 @@ class HandEvaluator {
  *   Required for the overcard categorizations (isOvercard, isTwoOvercards, isOvercardAndMiddleCard,
  *   isOvercardAndUndercard, isTwoMiddleCards, isMiddleAndUndercard, isTwoUndercards); without it those
  *   properties are always false. Both cards must be present in `cards`.
+ * @param {string[]|null} [villainRange=null] - Optional villain hands as exact combos ('AhKd') or shorthand
+ *   ('QQ', 'AKs', 'AKo', 'AK', 'TT+', 'ATs+'). When supplied, each evaluation includes
+ *   `villainRange: { boardBlocks, heroBlocks, allBlocks }`, each `{ unblocked: [], blocked: [] }` of exact combos.
  * @returns {Object} Object mapping sorted hand strings (e.g., "As, Ks, Qs, Js, Ts") to evaluation objects with boolean fields for all hand types and draws
  */
-function evaluateHand(cards, strict = true, holeCards = null) {
-  const evaluator = new HandEvaluator(cards, strict, holeCards);
+function evaluateHand(cards, strict = true, holeCards = null, villainRange = null) {
+  const evaluator = new HandEvaluator(cards, strict, holeCards, villainRange);
   return evaluator.evaluation;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poker-extval",
-  "version": "3.3.4",
+  "version": "3.4.0",
   "description": "Poker hand evaluator with comprehensive test suite",
   "main": "evaluator.js",
   "files": [