pixi-rainman-game-engine 0.3.0 → 0.3.2

package/dist/application/SpinLogic/SpinLogic.d.ts

@@ -18,15 +18,73 @@ export declare class SpinLogic {
     private readonly _standaloneTransformations;
     private readonly _extraData;
     constructor(spinConfig: AdaptedSpinResponse, gameConfig: ApiConfig);
+    /**
+     * Getter for post spin balance
+     * @public
+     * @returns {number} post spin balance
+     */
     get postSpinBalance(): number;
+    /**
+     * Getter for win total amount
+     * @public
+     * @returns {number} win total amount
+     */
     get winTotalAmount(): number;
+    /**
+     * Getter for win total streak amount
+     * @public
+     * @returns {number} win total streak amount
+     */
     get winTotalStreakAmount(): number;
+    /**
+     * Getter for win total amount without mystery wins
+     * @public
+     * @returns {number} win total amount without mystery wins
+     */
     get winTotalAmountWithoutMystery(): number;
+    /**
+     * Getter for on stop blinds configuration
+     * @public
+     * @returns {SymbolReels} on stop blinds configuration
+     */
     get onStopBlindsConfiguration(): SymbolReels;
+    /**
+     * Getter for final blinds configuration
+     * @public
+     * @returns {SymbolReels} final blinds configuration
+     */
     get finalBlindsConfiguration(): SymbolReels;
+    /**
+     * Getter for available free spins
+     * @public
+     * @returns {number} available free spins
+     */
     get availableFreeSpins(): number;
+    /**
+     * Getter for indicator if there's mystery win
+     * @public
+     * @returns {boolean} has mystery win
+     */
     get hasMysteryWin(): boolean;
+    /**
+     * Getter for win scenarios
+     * @public
+     * @returns {WinScenarios[]} win scenarios
+     */
     get winScenarios(): WinScenarios[];
+    /**
+     * Getter for standalone transformations
+     * @public
+     * @returns {TransformationDetails[][]} standalone transformations
+     */
     get standaloneTransformations(): TransformationDetails[][];
+    /**
+     * Getter for extra data
+     *
+     * **NOTE**: Extra data can be different between games in general, as some games have
+     *       unique extra data structures.
+     * @public
+     * @returns {ExtraData} extra data
+     */
     get extraData(): ExtraData;
 }

package/dist/application/SpinLogic/SpinLogic.js

@@ -29,38 +29,96 @@ export class SpinLogic {
         this._extraData = spinLogicReader.extraData;
         logInfo("Spin logic", JSON.parse(JSON.stringify(this)));
     }
+    /**
+     * Getter for post spin balance
+     * @public
+     * @returns {number} post spin balance
+     */
     get postSpinBalance() {
         return this._postSpinBalance;
     }
+    /**
+     * Getter for win total amount
+     * @public
+     * @returns {number} win total amount
+     */
     get winTotalAmount() {
         return this._winTotalAmount;
     }
+    /**
+     * Getter for win total streak amount
+     * @public
+     * @returns {number} win total streak amount
+     */
     get winTotalStreakAmount() {
         return this._winScenarios.reduce((accumulator, scenario) => accumulator +
             scenario.wins.reduce((winAccumulator, currentWin) => currentWin.type === PossibleWins.streak ? winAccumulator + currentWin.amount : winAccumulator, 0), 0);
     }
+    /**
+     * Getter for win total amount without mystery wins
+     * @public
+     * @returns {number} win total amount without mystery wins
+     */
     get winTotalAmountWithoutMystery() {
         return this._winScenarios.reduce((accumulator, scenario) => accumulator +
             scenario.wins.reduce((winAccumulator, currentWin) => currentWin.type === PossibleWins.mystery ? winAccumulator : winAccumulator + currentWin.amount, 0), 0);
     }
+    /**
+     * Getter for on stop blinds configuration
+     * @public
+     * @returns {SymbolReels} on stop blinds configuration
+     */
     get onStopBlindsConfiguration() {
         return this._onStopBlindsConfiguration;
     }
+    /**
+     * Getter for final blinds configuration
+     * @public
+     * @returns {SymbolReels} final blinds configuration
+     */
     get finalBlindsConfiguration() {
         return this._finalBlindsConfiguration;
     }
+    /**
+     * Getter for available free spins
+     * @public
+     * @returns {number} available free spins
+     */
     get availableFreeSpins() {
         return this._availableFreeSpins;
     }
+    /**
+     * Getter for indicator if there's mystery win
+     * @public
+     * @returns {boolean} has mystery win
+     */
     get hasMysteryWin() {
         return this._hasMysteryWin;
     }
+    /**
+     * Getter for win scenarios
+     * @public
+     * @returns {WinScenarios[]} win scenarios
+     */
     get winScenarios() {
         return this._winScenarios;
     }
+    /**
+     * Getter for standalone transformations
+     * @public
+     * @returns {TransformationDetails[][]} standalone transformations
+     */
     get standaloneTransformations() {
         return this._standaloneTransformations;
     }
+    /**
+     * Getter for extra data
+     *
+     * **NOTE**: Extra data can be different between games in general, as some games have
+     *       unique extra data structures.
+     * @public
+     * @returns {ExtraData} extra data
+     */
     get extraData() {
         return this._extraData;
     }

package/dist/application/SpinLogic/SpinLogicDTO.d.ts

@@ -4,22 +4,90 @@ import { AdaptedSpinResponse } from "./types";
 import { WinScenarios } from "./WinScenarios";
 /**
  * This class represents mapped data from backend
+ * It takes raw spin data and adapts it to the format used in the game.
+ * @class SpinLogicDTO
+ * @typedef {SpinLogicDTO}
+ * @property {AdaptedSpinResponse} rawData - The raw data from the backend.
+ * @property {ApiConfig} gameConfig - The game configuration used to map IDs.
  */
 export declare class SpinLogicDTO {
     private rawData;
     private gameConfig;
     constructor(rawData: AdaptedSpinResponse, gameConfig: ApiConfig);
+    /**
+     * Getter for updated balance
+     * @public
+     * @returns {number} updated balance
+     * @throws {Error} if balance is not found in ApiResponse
+     */
     get updatedBalance(): number;
+    /**
+     * Getter for free spins remaining
+     * @public
+     * @returns {number} free spins remaining
+     * @throws {Error} if available_free_spins is not found in ApiResponse
+     */
     get freeSpinsRemaining(): number;
+    /**
+     * Getter for total win amount
+     * @public
+     * @returns {number} total win amount
+     * @throws {Error} if win_amount_total is not found in ApiResponse
+     */
     get totalWonAmount(): number;
+    /**
+     * Getter for final blinds configuration
+     * This is a final configuration of symbols on reels after the spin.
+     * @public
+     * @returns {SymbolReels} final blinds configuration
+     * @throws {Error} if finalBlindsConfiguration is not found in ApiResponse
+     */
     get finalBlindsConfiguration(): SymbolReels;
+    /**
+     * Getter for on stop blinds configuration
+     * This is a configuration of symbols on reels when the spin stops.
+     * @public
+     * @returns {SymbolReels} on stop blinds configuration
+     * @throws {Error} if symbolsOnReels is not found in ApiResponse
+     */
     get onStopBlindsConfiguration(): SymbolReels;
+    /**
+     * Getter for extra data, which provides additional information about the spin.
+     * In some games, this can include information about the spin's outcome,
+     * such as whether it was a win, the type of win, or any special features
+     * that were triggered during the spin.
+     * @public
+     * @returns {ExtraData} extra data
+     */
     get extraData(): import("../../connectivity").ExtraData;
+    /**
+     * Getter for win scenarios
+     * This provides information about the wins that occurred during the spin.
+     * @public
+     * @returns {WinScenarios[]} array of win scenarios
+     */
     get winScenarios(): WinScenarios[];
+    /**
+     * Getter for standalone transformations
+     * This provides information about the transformations that occurred during the spin.
+     * Standalone transformations are not part of a win scenario,
+     * but are still important for the game logic.
+     * @public
+     * @returns {TransformationDetails[][]} array of standalone transformations
+     */
     get standaloneTransformations(): TransformationDetails[][];
+    /**
+     * Getter for mystery wins are in the spin
+     * This checks if there are any mystery wins in the spin.
+     * Mystery wins are special types of wins that can occur in some games,
+     * and they are usually triggered by specific symbols.
+     * @public
+     * @returns {boolean} whether there are mystery wins
+     */
     get hasMysteryWin(): boolean;
     /**
      * Function for mapping the single win from raw backend data
+     * @private
      * @param {WinDetails} singleWin single win from raw backend data
      * @param {number} availableFreeSpins number of available free spins (if game have free spins)
      * @returns {Win} mapped win
@@ -27,6 +95,7 @@ export declare class SpinLogicDTO {
     private getSingleWin;
     /**
      * Function for mapping wins from raw backend data
+     * @private
      * @param {WinWithTransformation} rawData raw data from backend
      * @param {number} availableFreeSpins number of available free spins (if game have free spins)
      * @returns {Win[]} mapped array of wins
@@ -34,6 +103,7 @@ export declare class SpinLogicDTO {
     private getWinsFromRawData;
     /**
      * Function for converting backend symbol id to frontend symbol id
+     * @private
      * @param {string} symbol backend symbol id
      * @returns {SymbolId} frontend symbol id
      */

package/dist/application/SpinLogic/SpinLogicDTO.js

@@ -3,6 +3,11 @@ import { RainMan } from "../../Rainman";
 import { WinScenarios } from "./WinScenarios";
 /**
  * This class represents mapped data from backend
+ * It takes raw spin data and adapts it to the format used in the game.
+ * @class SpinLogicDTO
+ * @typedef {SpinLogicDTO}
+ * @property {AdaptedSpinResponse} rawData - The raw data from the backend.
+ * @property {ApiConfig} gameConfig - The game configuration used to map IDs.
  */
 export class SpinLogicDTO {
     rawData;
@@ -11,6 +16,12 @@ export class SpinLogicDTO {
         this.rawData = rawData;
         this.gameConfig = gameConfig;
     }
+    /**
+     * Getter for updated balance
+     * @public
+     * @returns {number} updated balance
+     * @throws {Error} if balance is not found in ApiResponse
+     */
     get updatedBalance() {
         try {
             return this.rawData.balance;
@@ -19,6 +30,12 @@ export class SpinLogicDTO {
             throw new Error("No balance found in ApiResponse!");
         }
     }
+    /**
+     * Getter for free spins remaining
+     * @public
+     * @returns {number} free spins remaining
+     * @throws {Error} if available_free_spins is not found in ApiResponse
+     */
     get freeSpinsRemaining() {
         try {
             return this.rawData.availableFreeSpins;
@@ -27,6 +44,12 @@ export class SpinLogicDTO {
             throw new Error("No available_free_spins found in ApiResponse!");
         }
     }
+    /**
+     * Getter for total win amount
+     * @public
+     * @returns {number} total win amount
+     * @throws {Error} if win_amount_total is not found in ApiResponse
+     */
     get totalWonAmount() {
         try {
             return this.rawData.winAmountTotal;
@@ -35,32 +58,77 @@ export class SpinLogicDTO {
             throw new Error("No win_amount_total found in ApiResponse!");
         }
     }
+    /**
+     * Getter for final blinds configuration
+     * This is a final configuration of symbols on reels after the spin.
+     * @public
+     * @returns {SymbolReels} final blinds configuration
+     * @throws {Error} if finalBlindsConfiguration is not found in ApiResponse
+     */
     get finalBlindsConfiguration() {
         return this.rawData.finalBlindsConfiguration.map((reel) => reel.map((symbol) => this.stringToSymbolId(symbol)));
     }
+    /**
+     * Getter for on stop blinds configuration
+     * This is a configuration of symbols on reels when the spin stops.
+     * @public
+     * @returns {SymbolReels} on stop blinds configuration
+     * @throws {Error} if symbolsOnReels is not found in ApiResponse
+     */
     get onStopBlindsConfiguration() {
         return this.rawData.symbolsOnReels.map((reel) => reel.map((symbol) => this.stringToSymbolId(symbol)));
     }
+    /**
+     * Getter for extra data, which provides additional information about the spin.
+     * In some games, this can include information about the spin's outcome,
+     * such as whether it was a win, the type of win, or any special features
+     * that were triggered during the spin.
+     * @public
+     * @returns {ExtraData} extra data
+     */
     get extraData() {
         return this.rawData.extraData;
     }
+    /**
+     * Getter for win scenarios
+     * This provides information about the wins that occurred during the spin.
+     * @public
+     * @returns {WinScenarios[]} array of win scenarios
+     */
     get winScenarios() {
         const { results, availableFreeSpins } = this.rawData;
         if (results === undefined)
             return [];
         return results.map((result) => new WinScenarios(this.getWinsFromRawData(result, availableFreeSpins), result.transformations));
     }
+    /**
+     * Getter for standalone transformations
+     * This provides information about the transformations that occurred during the spin.
+     * Standalone transformations are not part of a win scenario,
+     * but are still important for the game logic.
+     * @public
+     * @returns {TransformationDetails[][]} array of standalone transformations
+     */
     get standaloneTransformations() {
         const { standaloneTransformations } = this.rawData;
         if (!standaloneTransformations)
             return [];
         return standaloneTransformations;
     }
+    /**
+     * Getter for mystery wins are in the spin
+     * This checks if there are any mystery wins in the spin.
+     * Mystery wins are special types of wins that can occur in some games,
+     * and they are usually triggered by specific symbols.
+     * @public
+     * @returns {boolean} whether there are mystery wins
+     */
     get hasMysteryWin() {
         return this.winScenarios.some((winScenario) => winScenario.wins.some((win) => win.type === PossibleWins.mystery));
     }
     /**
      * Function for mapping the single win from raw backend data
+     * @private
      * @param {WinDetails} singleWin single win from raw backend data
      * @param {number} availableFreeSpins number of available free spins (if game have free spins)
      * @returns {Win} mapped win
@@ -84,6 +152,7 @@ export class SpinLogicDTO {
     }
     /**
      * Function for mapping wins from raw backend data
+     * @private
      * @param {WinWithTransformation} rawData raw data from backend
      * @param {number} availableFreeSpins number of available free spins (if game have free spins)
      * @returns {Win[]} mapped array of wins
@@ -93,6 +162,7 @@ export class SpinLogicDTO {
     }
     /**
      * Function for converting backend symbol id to frontend symbol id
+     * @private
      * @param {string} symbol backend symbol id
      * @returns {SymbolId} frontend symbol id
      */

package/dist/application/SpinLogic/WinScenarios.d.ts

@@ -1,11 +1,23 @@
 import { TransformationDetails, Win } from "../../connectivity";
 /**
  * This class represents win and transformation scenarios described in {@link transformationTypes} and {@link PossibleWins}
+ * @class WinScenarios
+ * @typedef {WinScenarios}
  */
 export declare class WinScenarios {
     private readonly _wins;
     private readonly _transformations;
     constructor(wins: Win[], transformations: TransformationDetails[]);
+    /**
+     * Getter for wins
+     * @public
+     * @returns {Win[]} array of wins
+     */
     get wins(): Win[];
+    /**
+     * Getter for transformations
+     * @public
+     * @returns {TransformationDetails[]} array of transformations
+     */
     get transformations(): TransformationDetails[];
 }

package/dist/application/SpinLogic/WinScenarios.js

@@ -1,5 +1,7 @@
 /**
  * This class represents win and transformation scenarios described in {@link transformationTypes} and {@link PossibleWins}
+ * @class WinScenarios
+ * @typedef {WinScenarios}
  */
 export class WinScenarios {
     _wins;
@@ -8,9 +10,19 @@ export class WinScenarios {
         this._wins = wins;
         this._transformations = transformations;
     }
+    /**
+     * Getter for wins
+     * @public
+     * @returns {Win[]} array of wins
+     */
     get wins() {
         return this._wins;
     }
+    /**
+     * Getter for transformations
+     * @public
+     * @returns {TransformationDetails[]} array of transformations
+     */
     get transformations() {
         return this._transformations;
     }

package/dist/application/SpinLogic/types.d.ts

@@ -1,4 +1,14 @@
 import { ExtraData, SymbolReels, TransformationDetails, WinWithTransformation } from "../../connectivity";
+/**
+ * Type for adapted spin response
+ * This type represents the structure of the spin response
+ * that is adapted from the backend to the format used in the game.
+ * It includes information about the spin action, balance, available free spins,
+ * symbols on reels, final blinds configuration, total win amount,
+ * results of the spin with transformations, standalone transformations,
+ * and extra data.
+ * @typedef {AdaptedSpinResponse}
+ */
 export type AdaptedSpinResponse = {
     action: string;
     balance: number;

package/dist/application/TimedActions/IncentiveComponent.d.ts

@@ -1,6 +1,16 @@
+/**
+ * Interface for incentive components
+ * This is used by refresh button to have spinning effect with arrows
+ * @typedef {IncentiveComponent}
+ */
 export interface IncentiveComponent {
     name: string;
     initIncentiveAction: (incentiveJobFlag: Record<string, boolean>, afterAllDoneCallback: () => void) => void;
     animate: () => void;
 }
+/**
+ * Type guard for incentive components
+ * @param {unknown} obj object to check
+ * @returns {boolean} whether the object is a valid IncentiveComponent
+ */
 export declare const isIncentiveComponentInterface: (obj: unknown) => obj is IncentiveComponent;

package/dist/application/TimedActions/IncentiveComponent.js

@@ -1,9 +1,17 @@
 import { z } from "zod";
+/**
+ * Schema for incentive components
+ */
 const incentiveComponentSchema = z.object({
     name: z.string(),
     initIncentiveAction: z.function().args(z.record(z.boolean()), z.function()),
-    animate: z.function(),
+    animate: z.function()
 });
+/**
+ * Type guard for incentive components
+ * @param {unknown} obj object to check
+ * @returns {boolean} whether the object is a valid IncentiveComponent
+ */
 export const isIncentiveComponentInterface = (obj) => {
     return incentiveComponentSchema.safeParse(obj).success;
 };

package/dist/application/TimedActions/TimedIncentiveController.d.ts

@@ -1,14 +1,51 @@
 import { IncentiveComponent } from "./IncentiveComponent";
+/**
+ * Controller for managing timed incentive actions
+ * @class TimedIncentiveController
+ * @typedef {TimedIncentiveController}
+ */
 export declare class TimedIncentiveController {
     private recentActivityTime;
     private timerTicker;
     private timer;
     private readonly incentiveComponents;
     constructor();
+    /**
+     * Updates the last time the user clicked
+     * @public
+     * @returns {void}
+     */
     updateLastTimeClicked(): void;
+    /**
+     * Animates all incentive components
+     * @public
+     * @returns {void}
+     */
     animateAll(): void;
+    /**
+     * Adds a new incentive component
+     * @public
+     * @param {IncentiveComponent} component component to add
+     * @returns {void}
+     */
     addComponent(component: IncentiveComponent): void;
+    /**
+     * Removes an incentive component
+     * @public
+     * @param {IncentiveComponent} component component to remove
+     * @returns {void}
+     */
     removeComponent(component: IncentiveComponent): void;
+    /**
+     * Handles the timed event
+     * @private
+     * @returns {void}
+     */
     private timedEvent;
+    /**
+     * Stops the timer ticker
+     * @private
+     * @returns {void}
+     */
     private stopTicker;
 }

package/dist/application/TimedActions/TimedIncentiveController.js

@@ -1,5 +1,10 @@
 import { Ticker } from "pixi.js";
 import { RainMan } from "../../Rainman";
+/**
+ * Controller for managing timed incentive actions
+ * @class TimedIncentiveController
+ * @typedef {TimedIncentiveController}
+ */
 export class TimedIncentiveController {
     recentActivityTime = performance.now();
     timerTicker = new Ticker();
@@ -11,9 +16,19 @@ export class TimedIncentiveController {
         this.timer = setInterval(this.timedEvent.bind(this), RainMan.config.idleTimeout);
         this.timerTicker.add(this.animateAll, this);
     }
+    /**
+     * Updates the last time the user clicked
+     * @public
+     * @returns {void}
+     */
     updateLastTimeClicked() {
         this.recentActivityTime = performance.now();
     }
+    /**
+     * Animates all incentive components
+     * @public
+     * @returns {void}
+     */
     animateAll() {
         Object.values(this.incentiveComponents).forEach((incentiveComponent) => {
             if (incentiveComponent !== null) {
@@ -21,14 +36,31 @@ export class TimedIncentiveController {
             }
         });
     }
+    /**
+     * Adds a new incentive component
+     * @public
+     * @param {IncentiveComponent} component component to add
+     * @returns {void}
+     */
     addComponent(component) {
         this.incentiveComponents[component.name] = component;
     }
+    /**
+     * Removes an incentive component
+     * @public
+     * @param {IncentiveComponent} component component to remove
+     * @returns {void}
+     */
     removeComponent(component) {
         if (this.incentiveComponents[component.name]) {
             this.incentiveComponents[component.name] = null;
         }
     }
+    /**
+     * Handles the timed event
+     * @private
+     * @returns {void}
+     */
     timedEvent() {
         const now = performance.now();
         const secondsElapsedFromLastUserActivity = Math.abs((this.recentActivityTime - now) / 1000);
@@ -44,6 +76,11 @@ export class TimedIncentiveController {
             });
         }
     }
+    /**
+     * Stops the timer ticker
+     * @private
+     * @returns {void}
+     */
     stopTicker() {
         this.timerTicker.stop();
     }

package/dist/application/setup.d.ts

@@ -1,6 +1,5 @@
 /**
  * This function is for setup the whole games
- *
  * Note: This should be done once at the lifecycle of the game
  * Function creates also the react layer
  * @returns {ReactNode} the root element with canvas and react layer

package/dist/application/setup.js

@@ -4,7 +4,6 @@ import { SettingsUI } from "../SettingsUI";
 import { changeResolution, disableMagnifyingGlassOnIOS, getDeviceOrientation, invokeStatsBoard, loadSoundsOnTabChange, resizeCanvas, setupFullscreenForIOS } from "../utils";
 /**
  * This function is for setup the whole games
- *
  * Note: This should be done once at the lifecycle of the game
  * Function creates also the react layer
  * @returns {ReactNode} the root element with canvas and react layer