@slot-engine/core 0.0.2 → 0.0.4

package/dist/index.d.mts

@@ -603,12 +603,6 @@ declare class GameState<TGameModes extends AnyGameModes, TSymbols extends AnySym
      */
     getCurrentGameMode(): GameMode;
     resetState(): void;
-    /**
-     * Checks if a max win is reached by comparing `wallet.currentWin` to `config.maxWin`.
-     *
-     * Should be called after `wallet.confirmSpinWin()`.
-     */
-    isMaxWinTriggered(): void;
     /**
      * Empties the list of pending records in the recorder.
      */
@@ -769,7 +763,7 @@ declare class Board<TGameModes extends AnyGameModes, TSymbols extends AnySymbols
      */
     getRandomReelStops(reels: Reels, reelStops: number[][], amount: number): Record<string, number>;
     /**
-     * Selects a random reelset based on the configured weights for the current game mode.\
+     * Selects a random reel set based on the configured weights of the current result set.\
      * Returns the reels as arrays of GameSymbols.
      */
     getRandomReelset(): Reels;
@@ -879,7 +873,7 @@ declare class GameConfig<TGameModes extends AnyGameModes = AnyGameModes, TSymbol
         readonly id: string;
         readonly name: string;
         readonly gameModes: Record<GameModeName, GameMode>;
-        readonly symbols: Map<TSymbols[number]["id"], TSymbols[number]>;
+        readonly symbols: Map<keyof TSymbols & string, TSymbols[keyof TSymbols]>;
         readonly padSymbols?: number;
         readonly scatterToFreespins: Record<string, Record<number, number>>;
         readonly anticipationTriggers: Record<SpinType, number>;
@@ -896,7 +890,7 @@ declare class GameConfig<TGameModes extends AnyGameModes = AnyGameModes, TSymbol
     /**
      * Retrieves a reel set by its ID within a specific game mode.
      */
-    getReelsetById(gameMode: string, id: string): ReelGenerator;
+    getReelsetById(gameMode: string, id: string): Reels;
     /**
      * Retrieves the number of free spins awarded for a given spin type and scatter count.
      */
@@ -904,11 +898,11 @@ declare class GameConfig<TGameModes extends AnyGameModes = AnyGameModes, TSymbol
     /**
      * Retrieves a result set by its criteria within a specific game mode.
      */
-    getGameModeCriteria(mode: string, criteria: string): ResultSet<any>;
+    getResultSetByCriteria(mode: string, criteria: string): ResultSet<any>;
     /**
      * Returns all configured symbols as an array.
      */
-    getSymbolArray(): TSymbols[number][];
+    getSymbolArray(): TSymbols[keyof TSymbols][];
     static SPIN_TYPE: {
         readonly BASE_GAME: "basegame";
         readonly FREE_SPINS: "freespins";
@@ -928,7 +922,7 @@ declare class WinType {
      *
      * This gives the WinType access to the current board.
      */
-    context(ctx: AnySimulationContext): WinType;
+    context(ctx: SimulationContext<any, any, any>): WinType;
     protected ensureContext(): void;
     /**
      * Implementation of win evaluation logic. Sets `this.payout` and `this.winCombinations`.
@@ -985,7 +979,7 @@ type WildSymbol = GameSymbol | Record<string, any>;
 declare class LinesWinType extends WinType {
     protected lines: Record<number, number[]>;
     protected winCombinations: LineWinCombination[];
-    context: (ctx: AnySimulationContext) => LinesWinType;
+    context: (ctx: SimulationContext<any, any, any>) => LinesWinType;
     getWins: () => {
         payout: number;
         winCombinations: LineWinCombination[];
@@ -1175,64 +1169,14 @@ declare class SlotGame<TGameModes extends AnyGameModes = AnyGameModes, TSymbols
  * @internal
  */
 interface CommonGameOptions<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> {
-    /**
-     * The unique identifier of the game, used for configuration and identification.
-     */
     id: string;
-    /**
-     * The name of the game, used for display purposes.
-     */
     name: string;
-    /**
-     * A GameMode is the core structure of a slot, defining the board,\
-     * bet cost, win type, and other properties.
-     *
-     * One-off mechanisms can also be injected into the core game logic from here.
-     */
     gameModes: Record<GameModeName, GameMode>;
-    /**
-     * A list of all symbols that will appear on the reels.
-     */
-    symbols: GameSymbol[];
-    /**
-     * A mapping from spin type to scatter counts to the number of free spins awarded.
-     *
-     * @example
-     * ```ts
-     * scatterToFreespins: {
-     *   [GameConfig.CONSTANTS.BASE_GAME]: {
-     *     3: 10,
-     *     4: 12,
-     *     5: 15,
-     *   },
-     *   [GameConfig.CONSTANTS.FREE_SPINS]: {
-     *     3: 6,
-     *     4: 8,
-     *     5: 10,
-     *   },
-     * },
-     * ```
-     */
+    symbols: TSymbols;
     scatterToFreespins: Record<string, Record<number, number>>;
-    /**
-     * If set, this will pad the board with symbols on the top and bottom of the reels.\
-     * Useful for teasing symbols right above or below the active board.
-     *
-     * Default: 1
-     */
     padSymbols?: number;
-    /**
-     * The maximum win multiplier of the game, e.g. 5000 for a 5000x max win.
-     */
     maxWinX: number;
-    /**
-     * Hooks are used to inject custom logic at specific points in the game flow.\
-     * Some required hooks must be implemented for certain features to work.
-     */
     hooks: GameHooks<TGameModes, TSymbols, TUserState>;
-    /**
-     * Custom additional state that can be used in game flow logic.
-     */
     userState?: TUserState;
 }
 /**
@@ -1246,7 +1190,7 @@ type AnyGameModes = Record<string, GameMode>;
 /**
  * @internal
  */
-type AnySymbols = GameSymbol[];
+type AnySymbols = Record<string, GameSymbol>;
 /**
  * @internal
  */
@@ -1280,19 +1224,67 @@ type HookContext<T> = T extends SlotGame<infer G, infer S, infer U> ? Simulation
 
 type InferGameType<TGameModes extends AnyGameModes, TSymbols extends AnySymbols, TUserState extends AnyUserData> = SlotGame<TGameModes, TSymbols, TUserState>;
 interface CreateSlotGameOpts<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> {
+    /**
+     * The unique identifier of the game, used for configuration and identification.
+     */
     id: CommonGameOptions["id"];
+    /**
+     * The name of the game, used for display purposes.
+     */
     name: CommonGameOptions["name"];
+    /**
+     * A GameMode is the core structure of a slot, defining the board,\
+     * bet cost, win type, and other properties.
+     */
     gameModes: TGameModes;
+    /**
+     * A list of all symbols that will appear on the reels.
+     */
     symbols: TSymbols;
+    /**
+     * A mapping from spin type to scatter counts to the number of free spins awarded.
+     *
+     * @example
+     * ```ts
+     * scatterToFreespins: {
+     *   [GameConfig.SPIN_TYPE.BASE_GAME]: {
+     *     3: 10,
+     *     4: 12,
+     *     5: 15,
+     *   },
+     *   [GameConfig.SPIN_TYPE.FREE_SPINS]: {
+     *     3: 6,
+     *     4: 8,
+     *     5: 10,
+     *   },
+     * },
+     * ```
+     */
     scatterToFreespins: CommonGameOptions["scatterToFreespins"];
+    /**
+     * If set, this will pad the board with symbols on the top and bottom of the reels.\
+     * Useful for teasing symbols right above or below the active board.
+     *
+     * Default: 1
+     */
     padSymbols?: CommonGameOptions["padSymbols"];
+    /**
+     * The maximum win multiplier of the game, e.g. 5000 for a 5000x max win.
+     */
     maxWinX: CommonGameOptions["maxWinX"];
+    /**
+     * Custom additional state that can be used in game flow logic.
+     */
     userState?: TUserState;
+    /**
+     * Hooks are used to inject custom logic at specific points in the game flow.\
+     * Some required hooks must be implemented for certain features to work.
+     */
     hooks: CommonGameOptions<TGameModes, TSymbols, TUserState>["hooks"];
 }
 declare function createSlotGame<TGame>(opts: TGame extends InferGameType<infer G, infer S, infer U> ? CreateSlotGameOpts<G, S, U> : never): TGame;
 declare const defineUserState: <TUserState extends AnyUserData>(data: TUserState) => TUserState;
-declare const defineSymbols: <TSymbol extends GameSymbol>(symbols: TSymbol[]) => TSymbol[];
+declare const defineSymbols: <TSymbols extends AnySymbols>(symbols: TSymbols) => TSymbols;
 declare const defineGameModes: <TGameModes extends AnyGameModes>(gameModes: TGameModes) => TGameModes;
 declare const defineReelSets: <TSymbols extends AnySymbols>(reelSets: ReelGenerator[]) => ReelGenerator[];
 

package/dist/index.d.ts

@@ -603,12 +603,6 @@ declare class GameState<TGameModes extends AnyGameModes, TSymbols extends AnySym
      */
     getCurrentGameMode(): GameMode;
     resetState(): void;
-    /**
-     * Checks if a max win is reached by comparing `wallet.currentWin` to `config.maxWin`.
-     *
-     * Should be called after `wallet.confirmSpinWin()`.
-     */
-    isMaxWinTriggered(): void;
     /**
      * Empties the list of pending records in the recorder.
      */
@@ -769,7 +763,7 @@ declare class Board<TGameModes extends AnyGameModes, TSymbols extends AnySymbols
      */
     getRandomReelStops(reels: Reels, reelStops: number[][], amount: number): Record<string, number>;
     /**
-     * Selects a random reelset based on the configured weights for the current game mode.\
+     * Selects a random reel set based on the configured weights of the current result set.\
      * Returns the reels as arrays of GameSymbols.
      */
     getRandomReelset(): Reels;
@@ -879,7 +873,7 @@ declare class GameConfig<TGameModes extends AnyGameModes = AnyGameModes, TSymbol
         readonly id: string;
         readonly name: string;
         readonly gameModes: Record<GameModeName, GameMode>;
-        readonly symbols: Map<TSymbols[number]["id"], TSymbols[number]>;
+        readonly symbols: Map<keyof TSymbols & string, TSymbols[keyof TSymbols]>;
         readonly padSymbols?: number;
         readonly scatterToFreespins: Record<string, Record<number, number>>;
         readonly anticipationTriggers: Record<SpinType, number>;
@@ -896,7 +890,7 @@ declare class GameConfig<TGameModes extends AnyGameModes = AnyGameModes, TSymbol
     /**
      * Retrieves a reel set by its ID within a specific game mode.
      */
-    getReelsetById(gameMode: string, id: string): ReelGenerator;
+    getReelsetById(gameMode: string, id: string): Reels;
     /**
      * Retrieves the number of free spins awarded for a given spin type and scatter count.
      */
@@ -904,11 +898,11 @@ declare class GameConfig<TGameModes extends AnyGameModes = AnyGameModes, TSymbol
     /**
      * Retrieves a result set by its criteria within a specific game mode.
      */
-    getGameModeCriteria(mode: string, criteria: string): ResultSet<any>;
+    getResultSetByCriteria(mode: string, criteria: string): ResultSet<any>;
     /**
      * Returns all configured symbols as an array.
      */
-    getSymbolArray(): TSymbols[number][];
+    getSymbolArray(): TSymbols[keyof TSymbols][];
     static SPIN_TYPE: {
         readonly BASE_GAME: "basegame";
         readonly FREE_SPINS: "freespins";
@@ -928,7 +922,7 @@ declare class WinType {
      *
      * This gives the WinType access to the current board.
      */
-    context(ctx: AnySimulationContext): WinType;
+    context(ctx: SimulationContext<any, any, any>): WinType;
     protected ensureContext(): void;
     /**
      * Implementation of win evaluation logic. Sets `this.payout` and `this.winCombinations`.
@@ -985,7 +979,7 @@ type WildSymbol = GameSymbol | Record<string, any>;
 declare class LinesWinType extends WinType {
     protected lines: Record<number, number[]>;
     protected winCombinations: LineWinCombination[];
-    context: (ctx: AnySimulationContext) => LinesWinType;
+    context: (ctx: SimulationContext<any, any, any>) => LinesWinType;
     getWins: () => {
         payout: number;
         winCombinations: LineWinCombination[];
@@ -1175,64 +1169,14 @@ declare class SlotGame<TGameModes extends AnyGameModes = AnyGameModes, TSymbols
  * @internal
  */
 interface CommonGameOptions<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> {
-    /**
-     * The unique identifier of the game, used for configuration and identification.
-     */
     id: string;
-    /**
-     * The name of the game, used for display purposes.
-     */
     name: string;
-    /**
-     * A GameMode is the core structure of a slot, defining the board,\
-     * bet cost, win type, and other properties.
-     *
-     * One-off mechanisms can also be injected into the core game logic from here.
-     */
     gameModes: Record<GameModeName, GameMode>;
-    /**
-     * A list of all symbols that will appear on the reels.
-     */
-    symbols: GameSymbol[];
-    /**
-     * A mapping from spin type to scatter counts to the number of free spins awarded.
-     *
-     * @example
-     * ```ts
-     * scatterToFreespins: {
-     *   [GameConfig.CONSTANTS.BASE_GAME]: {
-     *     3: 10,
-     *     4: 12,
-     *     5: 15,
-     *   },
-     *   [GameConfig.CONSTANTS.FREE_SPINS]: {
-     *     3: 6,
-     *     4: 8,
-     *     5: 10,
-     *   },
-     * },
-     * ```
-     */
+    symbols: TSymbols;
     scatterToFreespins: Record<string, Record<number, number>>;
-    /**
-     * If set, this will pad the board with symbols on the top and bottom of the reels.\
-     * Useful for teasing symbols right above or below the active board.
-     *
-     * Default: 1
-     */
     padSymbols?: number;
-    /**
-     * The maximum win multiplier of the game, e.g. 5000 for a 5000x max win.
-     */
     maxWinX: number;
-    /**
-     * Hooks are used to inject custom logic at specific points in the game flow.\
-     * Some required hooks must be implemented for certain features to work.
-     */
     hooks: GameHooks<TGameModes, TSymbols, TUserState>;
-    /**
-     * Custom additional state that can be used in game flow logic.
-     */
     userState?: TUserState;
 }
 /**
@@ -1246,7 +1190,7 @@ type AnyGameModes = Record<string, GameMode>;
 /**
  * @internal
  */
-type AnySymbols = GameSymbol[];
+type AnySymbols = Record<string, GameSymbol>;
 /**
  * @internal
  */
@@ -1280,19 +1224,67 @@ type HookContext<T> = T extends SlotGame<infer G, infer S, infer U> ? Simulation
 
 type InferGameType<TGameModes extends AnyGameModes, TSymbols extends AnySymbols, TUserState extends AnyUserData> = SlotGame<TGameModes, TSymbols, TUserState>;
 interface CreateSlotGameOpts<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> {
+    /**
+     * The unique identifier of the game, used for configuration and identification.
+     */
     id: CommonGameOptions["id"];
+    /**
+     * The name of the game, used for display purposes.
+     */
     name: CommonGameOptions["name"];
+    /**
+     * A GameMode is the core structure of a slot, defining the board,\
+     * bet cost, win type, and other properties.
+     */
     gameModes: TGameModes;
+    /**
+     * A list of all symbols that will appear on the reels.
+     */
     symbols: TSymbols;
+    /**
+     * A mapping from spin type to scatter counts to the number of free spins awarded.
+     *
+     * @example
+     * ```ts
+     * scatterToFreespins: {
+     *   [GameConfig.SPIN_TYPE.BASE_GAME]: {
+     *     3: 10,
+     *     4: 12,
+     *     5: 15,
+     *   },
+     *   [GameConfig.SPIN_TYPE.FREE_SPINS]: {
+     *     3: 6,
+     *     4: 8,
+     *     5: 10,
+     *   },
+     * },
+     * ```
+     */
     scatterToFreespins: CommonGameOptions["scatterToFreespins"];
+    /**
+     * If set, this will pad the board with symbols on the top and bottom of the reels.\
+     * Useful for teasing symbols right above or below the active board.
+     *
+     * Default: 1
+     */
     padSymbols?: CommonGameOptions["padSymbols"];
+    /**
+     * The maximum win multiplier of the game, e.g. 5000 for a 5000x max win.
+     */
     maxWinX: CommonGameOptions["maxWinX"];
+    /**
+     * Custom additional state that can be used in game flow logic.
+     */
     userState?: TUserState;
+    /**
+     * Hooks are used to inject custom logic at specific points in the game flow.\
+     * Some required hooks must be implemented for certain features to work.
+     */
     hooks: CommonGameOptions<TGameModes, TSymbols, TUserState>["hooks"];
 }
 declare function createSlotGame<TGame>(opts: TGame extends InferGameType<infer G, infer S, infer U> ? CreateSlotGameOpts<G, S, U> : never): TGame;
 declare const defineUserState: <TUserState extends AnyUserData>(data: TUserState) => TUserState;
-declare const defineSymbols: <TSymbol extends GameSymbol>(symbols: TSymbol[]) => TSymbol[];
+declare const defineSymbols: <TSymbols extends AnySymbols>(symbols: TSymbols) => TSymbols;
 declare const defineGameModes: <TGameModes extends AnyGameModes>(gameModes: TGameModes) => TGameModes;
 declare const defineReelSets: <TSymbols extends AnySymbols>(reelSets: ReelGenerator[]) => ReelGenerator[];