@slot-engine/core 0.2.3 → 0.2.4

package/dist/index.d.mts

@@ -64,6 +64,7 @@ type PermanentFilePaths = {
     simulationSummary: string;
     statsPayouts: string;
     statsSummary: string;
+    statsRecords: string;
 };
 type TemporaryFilePaths = {
     tempBooks: (mode: string, i: number) => string;
@@ -785,7 +786,6 @@ declare class DataService<TGameModes extends AnyGameModes = AnyGameModes, TSymbo
     recordSymbolOccurrence(data: {
         kind: number;
         symbolId: string;
-        spinType: SpinType;
         [key: string]: any;
     }): void;
     /**
@@ -1246,7 +1246,40 @@ interface PayoutStatistics {
     };
 }
 interface AnalysisOpts {
+    /**
+     * Which game modes to analyze.
+     */
     gameModes: string[];
+    /**
+     * Configure which recorded properties to analyze.
+     * This will provide you with hit rates for the specified groupings.
+     * Each entry defines a grouping strategy for statistics.
+     *
+     * @example
+     * ```ts
+     * recordStats: [
+     *   { groupBy: ["symbolId", "kind", "spinType"] }, // All win combinations
+     *   { groupBy: ["symbolId", "kind"], filter: { spinType: "basegame" } }, // Base game win combinations only
+     *   { groupBy: ["criteria"] }, // Hit rate by result set criteria
+     * ]
+     * ```
+     */
+    recordStats?: RecordStatsConfig[];
+}
+interface RecordStatsConfig {
+    /**
+     * Properties to group by from the recorded search entries.\
+     * E.g. `["symbolId", "kind", "spinType"]` for symbol hit rates.
+     */
+    groupBy: string[];
+    /**
+     * Optional filter to only include records matching these values.
+     */
+    filter?: Record<string, string>;
+    /**
+     * Optional custom name for this stats group in the output.
+     */
+    name?: string;
 }
 interface Statistics {
     gameMode: string;

package/dist/index.d.ts

@@ -64,6 +64,7 @@ type PermanentFilePaths = {
     simulationSummary: string;
     statsPayouts: string;
     statsSummary: string;
+    statsRecords: string;
 };
 type TemporaryFilePaths = {
     tempBooks: (mode: string, i: number) => string;
@@ -785,7 +786,6 @@ declare class DataService<TGameModes extends AnyGameModes = AnyGameModes, TSymbo
     recordSymbolOccurrence(data: {
         kind: number;
         symbolId: string;
-        spinType: SpinType;
         [key: string]: any;
     }): void;
     /**
@@ -1246,7 +1246,40 @@ interface PayoutStatistics {
     };
 }
 interface AnalysisOpts {
+    /**
+     * Which game modes to analyze.
+     */
     gameModes: string[];
+    /**
+     * Configure which recorded properties to analyze.
+     * This will provide you with hit rates for the specified groupings.
+     * Each entry defines a grouping strategy for statistics.
+     *
+     * @example
+     * ```ts
+     * recordStats: [
+     *   { groupBy: ["symbolId", "kind", "spinType"] }, // All win combinations
+     *   { groupBy: ["symbolId", "kind"], filter: { spinType: "basegame" } }, // Base game win combinations only
+     *   { groupBy: ["criteria"] }, // Hit rate by result set criteria
+     * ]
+     * ```
+     */
+    recordStats?: RecordStatsConfig[];
+}
+interface RecordStatsConfig {
+    /**
+     * Properties to group by from the recorded search entries.\
+     * E.g. `["symbolId", "kind", "spinType"]` for symbol hit rates.
+     */
+    groupBy: string[];
+    /**
+     * Optional filter to only include records matching these values.
+     */
+    filter?: Record<string, string>;
+    /**
+     * Optional custom name for this stats group in the output.
+     */
+    name?: string;
 }
 interface Statistics {
     gameMode: string;

package/dist/index.js

@@ -92,7 +92,8 @@ function createPermanentFilePaths(basePath) {
     publishFiles: import_path.default.join(basePath, "publish_files"),
     simulationSummary: import_path.default.join(basePath, "simulation_summary.json"),
     statsPayouts: import_path.default.join(basePath, "stats_payouts.json"),
-    statsSummary: import_path.default.join(basePath, "stats_summary.json")
+    statsSummary: import_path.default.join(basePath, "stats_summary.json"),
+    statsRecords: import_path.default.join(basePath, "stats_records.json")
   };
 }
 function createTemporaryFilePaths(basePath, tempFolder) {
@@ -1101,7 +1102,10 @@ var DataService = class extends AbstractService {
    * Calls `ctx.services.data.record()` with the provided data.
    */
   recordSymbolOccurrence(data) {
-    this.record(data);
+    this.record({
+      ...data,
+      spinType: this.ctx().state.currentSpinType
+    });
   }
   /**
    * Adds an event to the book.
@@ -3123,15 +3127,21 @@ function getLessBetHitrate(payoutWeights, cost) {
 
 // src/analysis/index.ts
 var import_worker_threads3 = require("worker_threads");
+var import_chalk3 = __toESM(require("chalk"));
 var Analysis = class {
   game;
   constructor(game) {
     this.game = game;
   }
-  async runAnalysis(gameModes) {
+  async runAnalysis(opts) {
+    const { gameModes, recordStats = [] } = opts;
     if (!import_worker_threads3.isMainThread) return;
+    console.log(import_chalk3.default.gray("Starting analysis..."));
     this.getNumberStats(gameModes);
     this.getWinRanges(gameModes);
+    if (recordStats.length > 0) {
+      this.getRecordStats(gameModes, recordStats);
+    }
     console.log("Analysis complete. Files written to build directory.");
   }
   getNumberStats(gameModes) {
@@ -3308,6 +3318,85 @@ var Analysis = class {
     }
     writeJsonFile(meta.paths.statsPayouts, payoutRanges);
   }
+  getRecordStats(gameModes, recordStatsConfig) {
+    const meta = this.game.getMetadata();
+    const allStats = [];
+    for (const modeStr of gameModes) {
+      const lutOptimized = parseLookupTable(
+        import_fs4.default.readFileSync(meta.paths.lookupTablePublish(modeStr), "utf-8")
+      );
+      const totalWeight = getTotalLutWeight(lutOptimized);
+      const weightMap = /* @__PURE__ */ new Map();
+      lutOptimized.forEach(([bookId, weight]) => {
+        weightMap.set(bookId, weight);
+      });
+      const forceRecordsPath = meta.paths.forceRecords(modeStr);
+      if (!import_fs4.default.existsSync(forceRecordsPath)) continue;
+      const forceRecords = JSON.parse(
+        import_fs4.default.readFileSync(forceRecordsPath, "utf-8")
+      );
+      const modeStats = {
+        gameMode: modeStr,
+        groups: []
+      };
+      for (const config of recordStatsConfig) {
+        const groupName = config.name || config.groupBy.join("_");
+        const aggregated = /* @__PURE__ */ new Map();
+        for (const record of forceRecords) {
+          const searchMap = new Map(record.search.map((s) => [s.name, s.value]));
+          if (config.filter) {
+            let matches = true;
+            for (const [key2, value] of Object.entries(config.filter)) {
+              if (searchMap.get(key2) !== value) {
+                matches = false;
+                break;
+              }
+            }
+            if (!matches) continue;
+          }
+          const hasAllProps = config.groupBy.every((prop) => searchMap.has(prop));
+          if (!hasAllProps) continue;
+          const key = config.groupBy.map((prop) => searchMap.get(prop)).join("|");
+          const properties = Object.fromEntries(
+            config.groupBy.map((prop) => [prop, searchMap.get(prop)])
+          );
+          let totalWeight2 = 0;
+          for (const bookId of record.bookIds) {
+            totalWeight2 += weightMap.get(bookId) ?? 0;
+          }
+          const existing = aggregated.get(key);
+          if (existing) {
+            existing.count += record.timesTriggered;
+            existing.totalWeight += totalWeight2;
+          } else {
+            aggregated.set(key, {
+              properties,
+              count: record.timesTriggered,
+              totalWeight: totalWeight2
+            });
+          }
+        }
+        const items = Array.from(aggregated.entries()).map(([key, data]) => {
+          const hitRate = round(totalWeight / data.totalWeight, 4);
+          return {
+            key,
+            properties: data.properties,
+            count: data.count,
+            hitRateString: `1 in ${Math.round(hitRate).toLocaleString()}`,
+            hitRate
+          };
+        }).sort((a, b) => a.hitRate - b.hitRate);
+        modeStats.groups.push({
+          name: groupName,
+          groupBy: config.groupBy,
+          filter: config.filter,
+          items
+        });
+      }
+      allStats.push(modeStats);
+    }
+    writeJsonFile(meta.paths.statsRecords, allStats);
+  }
   getGameModeConfig(mode) {
     const config = this.game.getConfig().gameModes[mode];
     (0, import_assert6.default)(config, `Game mode "${mode}" not found in game config`);
@@ -3672,7 +3761,7 @@ var SlotGame = class _SlotGame {
    */
   runAnalysis(opts) {
     this.analyzer = new Analysis(this);
-    this.analyzer.runAnalysis(opts.gameModes);
+    this.analyzer.runAnalysis(opts);
   }
   /**
    * Runs the configured tasks: simulation, optimization, and/or analysis.