@slot-engine/core 0.1.3 → 0.1.5

package/dist/index.d.mts

@@ -89,8 +89,9 @@ declare class Simulation {
     private debug;
     private actualSims;
     private library;
-    private recorder;
     private wallet;
+    private recordsWriteStream;
+    private hasWrittenRecord;
     constructor(opts: SimulationOptions, gameConfigOpts: GameConfigOptions);
     runSimulation(opts: SimulationConfigOptions): Promise<void>;
     /**
@@ -148,13 +149,11 @@ declare class Simulation {
     private writeRecords;
     private writeIndexJson;
     private writeBooksJson;
-    private logSymbolOccurrences;
     /**
      * Compiles user configured game to JS for use in different Node processes
      */
     private preprocessFiles;
     private getSimRangesForChunks;
-    private mergeRecords;
     /**
      * Generates reelset CSV files for all game modes.
      */
@@ -699,6 +698,70 @@ interface GameModeOpts {
     isBonusBuy: boolean;
 }
 
+declare class WinType {
+    protected payout: number;
+    protected winCombinations: WinCombination[];
+    protected ctx: GameContext;
+    protected readonly wildSymbol?: WildSymbol;
+    constructor(opts: WinTypeOpts);
+    /**
+     * Implementation of win evaluation logic. Sets `this.payout` and `this.winCombinations`.
+     */
+    evaluateWins(board: Reels): this;
+    /**
+     * Custom post-processing of wins, e.g. for handling multipliers.
+     */
+    postProcess(func: PostProcessFn<typeof this.winCombinations>): this;
+    /**
+     * Returns the total payout and detailed win combinations.
+     */
+    getWins(): {
+        payout: number;
+        winCombinations: WinCombination[];
+    };
+    protected isWild(symbol: GameSymbol): boolean;
+    protected getSymbolPayout(symbol: GameSymbol, count: number): number;
+}
+interface WinTypeOpts {
+    /**
+     * A reference to the game context.
+     */
+    ctx: GameContext<any, any, any>;
+    /**
+     * Configuration used to identify wild symbols on the board.\
+     * You can either provide a specific `GameSymbol` instance or a set of properties to match against symbols on the board.
+     *
+     * @example
+     * If you have different wild symbols, each with a property `isWild: true`, you can define:
+     * ```ts
+     * wildSymbol: { isWild: true }
+     * ```
+     *
+     * @example
+     * If you have a single wild symbol instance, you can define:
+     * ```ts
+     * wildSymbol: myWildSymbol
+     * ```
+     */
+    wildSymbol?: WildSymbol;
+}
+type WinCombination = {
+    payout: number;
+    kind: number;
+    baseSymbol: GameSymbol;
+    symbols: Array<{
+        symbol: GameSymbol;
+        isWild: boolean;
+        substitutedFor?: GameSymbol;
+        reelIndex: number;
+        posIndex: number;
+    }>;
+};
+type PostProcessFn<TWinCombs extends WinCombination[]> = (wins: TWinCombs, ctx: GameContext) => {
+    winCombinations: TWinCombs;
+};
+type WildSymbol = GameSymbol | Record<string, any>;
+
 declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> extends AbstractService {
     constructor(ctx: () => GameContext<TGameModes, TSymbols, TUserState>);
     /**
@@ -737,6 +800,18 @@ declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbo
      * Also sets `state.triggeredFreespins` to true.
      */
     awardFreespins(amount: number): void;
+    /**
+     * Dedupes win symbols.
+     *
+     * Since it may be possible that multiple win combinations include the same symbol (e.g. Wilds),\
+     * this method ensures that each symbol is only listed once.
+     *
+     * If you want to tumble based on winning symbols, run them through this method first.
+     */
+    dedupeWinSymbols(winCombinations: WinCombination[]): {
+        reelIdx: number;
+        rowIdx: number;
+    }[];
 }
 
 declare class Wallet {
@@ -1181,70 +1256,6 @@ declare const defineUserState: <TUserState extends AnyUserData>(data: TUserState
 declare const defineSymbols: <TSymbols extends AnySymbols>(symbols: TSymbols) => TSymbols;
 declare const defineGameModes: <TGameModes extends AnyGameModes>(gameModes: TGameModes) => TGameModes;
 
-declare class WinType {
-    protected payout: number;
-    protected winCombinations: WinCombination[];
-    protected ctx: GameContext;
-    protected readonly wildSymbol?: WildSymbol;
-    constructor(opts: WinTypeOpts);
-    /**
-     * Implementation of win evaluation logic. Sets `this.payout` and `this.winCombinations`.
-     */
-    evaluateWins(board: Reels): this;
-    /**
-     * Custom post-processing of wins, e.g. for handling multipliers.
-     */
-    postProcess(func: PostProcessFn<typeof this.winCombinations>): this;
-    /**
-     * Returns the total payout and detailed win combinations.
-     */
-    getWins(): {
-        payout: number;
-        winCombinations: WinCombination[];
-    };
-    protected isWild(symbol: GameSymbol): boolean;
-    protected getSymbolPayout(symbol: GameSymbol, count: number): number;
-}
-interface WinTypeOpts {
-    /**
-     * A reference to the game context.
-     */
-    ctx: GameContext<any, any, any>;
-    /**
-     * Configuration used to identify wild symbols on the board.\
-     * You can either provide a specific `GameSymbol` instance or a set of properties to match against symbols on the board.
-     *
-     * @example
-     * If you have different wild symbols, each with a property `isWild: true`, you can define:
-     * ```ts
-     * wildSymbol: { isWild: true }
-     * ```
-     *
-     * @example
-     * If you have a single wild symbol instance, you can define:
-     * ```ts
-     * wildSymbol: myWildSymbol
-     * ```
-     */
-    wildSymbol?: WildSymbol;
-}
-type WinCombination = {
-    payout: number;
-    kind: number;
-    baseSymbol: GameSymbol;
-    symbols: Array<{
-        symbol: GameSymbol;
-        isWild: boolean;
-        substitutedFor?: GameSymbol;
-        reelIndex: number;
-        posIndex: number;
-    }>;
-};
-type PostProcessFn<TWinCombs extends WinCombination[]> = (wins: TWinCombs, ctx: GameContext) => {
-    winCombinations: TWinCombs;
-};
-type WildSymbol = GameSymbol | Record<string, any>;
-
 declare class LinesWinType extends WinType {
     protected lines: Record<number, number[]>;
     protected winCombinations: LineWinCombination[];
@@ -1580,4 +1591,4 @@ interface StandaloneBoardOptions {
     padSymbols: number;
 }
 
-export { type AnyGameModes, type AnySymbols, type AnyUserData, ClusterWinType, type GameContext, type GameHooks, GameMode, GameSymbol, GeneratedReelSet, type InferGameType, LinesWinType, ManywaysWinType, OptimizationConditions, OptimizationParameters, OptimizationScaling, type Reels, ResultSet, SPIN_TYPE, type SpinType, StandaloneBoard, StaticReelSet, createSlotGame, defineGameModes, defineSymbols, defineUserState };
+export { type AnyGameModes, type AnySymbols, type AnyUserData, ClusterWinType, type GameContext, type GameHooks, GameMode, GameSymbol, GeneratedReelSet, type InferGameType, LinesWinType, ManywaysWinType, OptimizationConditions, OptimizationParameters, OptimizationScaling, type Reels, ResultSet, SPIN_TYPE, type SpinType, StandaloneBoard, StaticReelSet, type WinCombination, createSlotGame, defineGameModes, defineSymbols, defineUserState };

package/dist/index.d.ts

@@ -89,8 +89,9 @@ declare class Simulation {
     private debug;
     private actualSims;
     private library;
-    private recorder;
     private wallet;
+    private recordsWriteStream;
+    private hasWrittenRecord;
     constructor(opts: SimulationOptions, gameConfigOpts: GameConfigOptions);
     runSimulation(opts: SimulationConfigOptions): Promise<void>;
     /**
@@ -148,13 +149,11 @@ declare class Simulation {
     private writeRecords;
     private writeIndexJson;
     private writeBooksJson;
-    private logSymbolOccurrences;
     /**
      * Compiles user configured game to JS for use in different Node processes
      */
     private preprocessFiles;
     private getSimRangesForChunks;
-    private mergeRecords;
     /**
      * Generates reelset CSV files for all game modes.
      */
@@ -699,6 +698,70 @@ interface GameModeOpts {
     isBonusBuy: boolean;
 }
 
+declare class WinType {
+    protected payout: number;
+    protected winCombinations: WinCombination[];
+    protected ctx: GameContext;
+    protected readonly wildSymbol?: WildSymbol;
+    constructor(opts: WinTypeOpts);
+    /**
+     * Implementation of win evaluation logic. Sets `this.payout` and `this.winCombinations`.
+     */
+    evaluateWins(board: Reels): this;
+    /**
+     * Custom post-processing of wins, e.g. for handling multipliers.
+     */
+    postProcess(func: PostProcessFn<typeof this.winCombinations>): this;
+    /**
+     * Returns the total payout and detailed win combinations.
+     */
+    getWins(): {
+        payout: number;
+        winCombinations: WinCombination[];
+    };
+    protected isWild(symbol: GameSymbol): boolean;
+    protected getSymbolPayout(symbol: GameSymbol, count: number): number;
+}
+interface WinTypeOpts {
+    /**
+     * A reference to the game context.
+     */
+    ctx: GameContext<any, any, any>;
+    /**
+     * Configuration used to identify wild symbols on the board.\
+     * You can either provide a specific `GameSymbol` instance or a set of properties to match against symbols on the board.
+     *
+     * @example
+     * If you have different wild symbols, each with a property `isWild: true`, you can define:
+     * ```ts
+     * wildSymbol: { isWild: true }
+     * ```
+     *
+     * @example
+     * If you have a single wild symbol instance, you can define:
+     * ```ts
+     * wildSymbol: myWildSymbol
+     * ```
+     */
+    wildSymbol?: WildSymbol;
+}
+type WinCombination = {
+    payout: number;
+    kind: number;
+    baseSymbol: GameSymbol;
+    symbols: Array<{
+        symbol: GameSymbol;
+        isWild: boolean;
+        substitutedFor?: GameSymbol;
+        reelIndex: number;
+        posIndex: number;
+    }>;
+};
+type PostProcessFn<TWinCombs extends WinCombination[]> = (wins: TWinCombs, ctx: GameContext) => {
+    winCombinations: TWinCombs;
+};
+type WildSymbol = GameSymbol | Record<string, any>;
+
 declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> extends AbstractService {
     constructor(ctx: () => GameContext<TGameModes, TSymbols, TUserState>);
     /**
@@ -737,6 +800,18 @@ declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbo
      * Also sets `state.triggeredFreespins` to true.
      */
     awardFreespins(amount: number): void;
+    /**
+     * Dedupes win symbols.
+     *
+     * Since it may be possible that multiple win combinations include the same symbol (e.g. Wilds),\
+     * this method ensures that each symbol is only listed once.
+     *
+     * If you want to tumble based on winning symbols, run them through this method first.
+     */
+    dedupeWinSymbols(winCombinations: WinCombination[]): {
+        reelIdx: number;
+        rowIdx: number;
+    }[];
 }
 
 declare class Wallet {
@@ -1181,70 +1256,6 @@ declare const defineUserState: <TUserState extends AnyUserData>(data: TUserState
 declare const defineSymbols: <TSymbols extends AnySymbols>(symbols: TSymbols) => TSymbols;
 declare const defineGameModes: <TGameModes extends AnyGameModes>(gameModes: TGameModes) => TGameModes;
 
-declare class WinType {
-    protected payout: number;
-    protected winCombinations: WinCombination[];
-    protected ctx: GameContext;
-    protected readonly wildSymbol?: WildSymbol;
-    constructor(opts: WinTypeOpts);
-    /**
-     * Implementation of win evaluation logic. Sets `this.payout` and `this.winCombinations`.
-     */
-    evaluateWins(board: Reels): this;
-    /**
-     * Custom post-processing of wins, e.g. for handling multipliers.
-     */
-    postProcess(func: PostProcessFn<typeof this.winCombinations>): this;
-    /**
-     * Returns the total payout and detailed win combinations.
-     */
-    getWins(): {
-        payout: number;
-        winCombinations: WinCombination[];
-    };
-    protected isWild(symbol: GameSymbol): boolean;
-    protected getSymbolPayout(symbol: GameSymbol, count: number): number;
-}
-interface WinTypeOpts {
-    /**
-     * A reference to the game context.
-     */
-    ctx: GameContext<any, any, any>;
-    /**
-     * Configuration used to identify wild symbols on the board.\
-     * You can either provide a specific `GameSymbol` instance or a set of properties to match against symbols on the board.
-     *
-     * @example
-     * If you have different wild symbols, each with a property `isWild: true`, you can define:
-     * ```ts
-     * wildSymbol: { isWild: true }
-     * ```
-     *
-     * @example
-     * If you have a single wild symbol instance, you can define:
-     * ```ts
-     * wildSymbol: myWildSymbol
-     * ```
-     */
-    wildSymbol?: WildSymbol;
-}
-type WinCombination = {
-    payout: number;
-    kind: number;
-    baseSymbol: GameSymbol;
-    symbols: Array<{
-        symbol: GameSymbol;
-        isWild: boolean;
-        substitutedFor?: GameSymbol;
-        reelIndex: number;
-        posIndex: number;
-    }>;
-};
-type PostProcessFn<TWinCombs extends WinCombination[]> = (wins: TWinCombs, ctx: GameContext) => {
-    winCombinations: TWinCombs;
-};
-type WildSymbol = GameSymbol | Record<string, any>;
-
 declare class LinesWinType extends WinType {
     protected lines: Record<number, number[]>;
     protected winCombinations: LineWinCombination[];
@@ -1580,4 +1591,4 @@ interface StandaloneBoardOptions {
     padSymbols: number;
 }
 
-export { type AnyGameModes, type AnySymbols, type AnyUserData, ClusterWinType, type GameContext, type GameHooks, GameMode, GameSymbol, GeneratedReelSet, type InferGameType, LinesWinType, ManywaysWinType, OptimizationConditions, OptimizationParameters, OptimizationScaling, type Reels, ResultSet, SPIN_TYPE, type SpinType, StandaloneBoard, StaticReelSet, createSlotGame, defineGameModes, defineSymbols, defineUserState };
+export { type AnyGameModes, type AnySymbols, type AnyUserData, ClusterWinType, type GameContext, type GameHooks, GameMode, GameSymbol, GeneratedReelSet, type InferGameType, LinesWinType, ManywaysWinType, OptimizationConditions, OptimizationParameters, OptimizationScaling, type Reels, ResultSet, SPIN_TYPE, type SpinType, StandaloneBoard, StaticReelSet, type WinCombination, createSlotGame, defineGameModes, defineSymbols, defineUserState };