pixi-rainman-game-engine 0.1.29 → 0.1.31

package/README.md

@@ -2,6 +2,50 @@
 
 This repository contains all the mechanics that used in RainMan games. This library uses pixi and pixi-spine as dependencies.
 
+### Development scripts
+
+In this repository you have directory `scripts`, contains scripts for deployment to digital ocean and preparing tags and releases for games. As you can use linux or MacOS environment, you should add permissions for executing the script. To do this you should perform a command:
+
+```sh
+chmod +x ./scripts
+```
+
+After adding permissions for scripts, to operate the scripts you should installed following programs:
+
+-   [gh](https://formulae.brew.sh/formula/gh)
+-   [jq](https://formulae.brew.sh/formula/jq)
+-   [git](https://formulae.brew.sh/formula/git)
+
+In the `scripts` directory, you have three scripts:
+
+1. `apply_diff.sh` \
+   This script applying should apply diff file for all of the games. This should automate adding the same changes to the all games that uses engine.
+
+    Example:
+
+    ```sh
+    ./scripts/apply_diff.sh "CD-XXX" "XXX" ./newChanges.diff
+    ```
+
+2. `auto_merge.sh` \
+   This scripts is used for merging pull requests with given issue. This scripts uses gh, which is responsible for communicating with github. This scripts, have option to create git tag and release for deployment. To enable this option you should add true second parameter.
+
+    Example:
+
+    ```sh
+    ./scripts/auto_merge.sh "CD-XXX"
+    ```
+
+3. `prepare_for_deployment.sh` \
+   This scripts is used to preparing for deployment on DigitalOcean. The script automates changing the version and adding date to version in `package.json` for each game. Default behavior is to increase the patch version of the game.
+   This script uses environment variable `PR_REVIEWER`, to add reviewer/s to each pr.
+
+    Example:
+
+    ```sh
+    ./scripts/prepare_for_deployment.sh "CD-XXX" "Commit message"
+    ```
+
 ### Scripts
 
 1. To build library
@@ -11,7 +55,7 @@ This repository contains all the mechanics that used in RainMan games. This libr
 2. To build library during development
 
     ```sh
-     yarn dev:build
+    yarn dev:build
     ```
 
     Modifying css files does not automatically reload server, after each change manual restart is needed.

package/dist/ComponentRegistry/ComponentRegistry.d.ts

@@ -1,6 +1,12 @@
 import { Application, Container } from "pixi.js";
 import { SpeedLevel } from "../application";
 import { RegistryMap } from "./types";
+/**
+ * Class for managing components in game
+ *
+ * @exports
+ * @class ComponentRegistry
+ */
 export declare class ComponentRegistry {
     private registry;
     private speedAdaptableComponents;

package/dist/ComponentRegistry/ComponentRegistry.js

@@ -2,6 +2,12 @@ import { isIncentiveComponentInterface, isSpeedAdapterInterface, SPEED_LEVELS, S
 import { SpeedControlButton } from "../components";
 import { RainMan } from "../Rainman";
 import { openFullscreen } from "../utils";
+/**
+ * Class for managing components in game
+ *
+ * @exports
+ * @class ComponentRegistry
+ */
 export class ComponentRegistry {
     registry = new Map();
     speedAdaptableComponents = new Set();

package/dist/ComponentRegistry/types.d.ts

@@ -1,4 +1,10 @@
 import { AbstractColumnsContainer, AbstractFrame, AbstractInnerFrame, AutoplayButton, Background, BaseButton, BUTTONS, COMPONENTS, FreeSpinButton, InfoButton, MessageBox, MoreButton, NegButton, PlusButton, RefreshButton, SpeedControlButton, StylefulUpdatableText, UpdatableTextComponent, UpdatableValueComponent, VolumeButton } from "../components";
+/**
+ * RegistryMap is a map of all components that are registered in the ComponentRegistry.
+ * It is used to type-check the components that are registered in the ComponentRegistry.
+ *
+ * @exports
+ */
 export interface RegistryMap {
     [MessageBox.autoSpinTextRegistryName]: UpdatableValueComponent;
     [MessageBox.currentWinTextRegistryName]: UpdatableTextComponent;

package/dist/DescribedPlayableAction/DescribedPlayableAction.d.ts

@@ -1,4 +1,7 @@
 import { Nullable, PlayableAction } from "../utils";
+/**
+ * Class representing a described playable action
+ */
 export declare class DescribedPlayableAction<T> {
     readonly type: T;
     action: PlayableAction;

package/dist/DescribedPlayableAction/DescribedPlayableAction.js

@@ -1,3 +1,6 @@
+/**
+ * Class representing a described playable action
+ */
 export class DescribedPlayableAction {
     type;
     action;

package/dist/application/ApiConfig/SymbolId.d.ts

@@ -1,5 +1,6 @@
 /**
  * Interface for specifying symbols in game
+ * This type can be modified for each game in engine.d.ts file
  *
  * @export
  * @interface SymbolIds

package/dist/application/ApiConfig/TransformationTypesId.d.ts

@@ -1,5 +1,6 @@
 /**
  * Interface for specifying transformation in game
+ * This type can be modified for each game in engine.d.ts file
  *
  * @export
  * @interface SymbolIds

package/dist/application/ApiConfig/WinTypeId.d.ts

@@ -1,5 +1,6 @@
 /**
  * Interface for specifying win in game
+ * This type can be modified for each game in engine.d.ts file
  *
  * @export
  * @interface WinTypeIds

package/dist/application/ButtonsEventManager/ButtonsEventManager.d.ts

@@ -1,5 +1,21 @@
 import { Nullable } from "../../utils";
 export declare const SPEED_PREFIX = "speed-";
+/**
+ * Class for managing buttons in games
+ *
+ * This class includes methods for enabling/disabling buttons in game.
+ *
+ * The buttons that include each game:
+ * - Plus button
+ * - Minus button
+ * - Speed button (React and Pixi Buttons)
+ * - Info Button
+ * - More Button
+ * - Autoplay Button
+ * - Volume Button
+ *
+ * @exports
+ */
 export declare class ButtonsEventManager {
     private settingsPlusButton;
     private settingsMinusButton;
@@ -7,7 +23,17 @@ export declare class ButtonsEventManager {
     private settingsSpeedTurtle;
     private settingsSpeedRabbit;
     private settingsSpeedCheetah;
+    /**
+     * Last layer invoked
+     *
+     * @memberof ButtonsEventManager
+     */
     private lastLayerInvoked;
+    /**
+     * Speed popup shown at for measuring time of showing speed popup
+     *
+     * @memberof ButtonsEventManager
+     */
     speedPopupShownAt: number;
     /**
      * Function for enabling/disabling buttons in game

package/dist/application/ButtonsEventManager/ButtonsEventManager.js

@@ -5,6 +5,22 @@ import { RainMan } from "../../Rainman";
 import { allUiItems, hideLayerIfPresent, UI_ITEMS } from "../../utils";
 import { SPEED_LEVELS } from "../SpeedState";
 export const SPEED_PREFIX = "speed-";
+/**
+ * Class for managing buttons in games
+ *
+ * This class includes methods for enabling/disabling buttons in game.
+ *
+ * The buttons that include each game:
+ * - Plus button
+ * - Minus button
+ * - Speed button (React and Pixi Buttons)
+ * - Info Button
+ * - More Button
+ * - Autoplay Button
+ * - Volume Button
+ *
+ * @exports
+ */
 export class ButtonsEventManager {
     settingsPlusButton = null;
     settingsMinusButton = null;
@@ -12,7 +28,17 @@ export class ButtonsEventManager {
     settingsSpeedTurtle = null;
     settingsSpeedRabbit = null;
     settingsSpeedCheetah = null;
+    /**
+     * Last layer invoked
+     *
+     * @memberof ButtonsEventManager
+     */
     lastLayerInvoked = "";
+    /**
+     * Speed popup shown at for measuring time of showing speed popup
+     *
+     * @memberof ButtonsEventManager
+     */
     speedPopupShownAt = 0;
     /**
      * Function for enabling/disabling buttons in game

package/dist/application/SoundManager/SoundManager.d.ts

@@ -1,5 +1,11 @@
 import { SpeedAdapterInterface, SpeedLevel, SpeedLevelDirectory } from "../SpeedState";
 import { SoundOverrides, SoundTrack } from "./types";
+/**
+ * Class for managing sound in game, uses the pixi sound library
+ * The class uses SoundTrack enum to access specified sounds
+ *
+ * @exports
+ */
 export declare class SoundManagerInstance implements SpeedAdapterInterface<SoundOverrides> {
     private static instance;
     static getInstance(): SoundManagerInstance;
@@ -12,11 +18,10 @@ export declare class SoundManagerInstance implements SpeedAdapterInterface<Sound
      *
      * @async
      * @param {Record<string, string>} assets
-     * @returns {Promise<void>}
      */
     loadSounds(assets: Record<string, string>): Promise<void>;
     /**
-     * Setter for volume level in game
+     * Function for setting volume level for each sound in game
      *
      * @param {number} volumeLevel
      */

package/dist/application/SoundManager/SoundManager.js

@@ -2,6 +2,12 @@ import { Sound } from "@pixi/sound";
 import { RainMan } from "../../Rainman";
 import { SoundTracks } from "./types";
 const soundsToLoop = [SoundTracks.mysteryFxLoop, SoundTracks.music];
+/**
+ * Class for managing sound in game, uses the pixi sound library
+ * The class uses SoundTrack enum to access specified sounds
+ *
+ * @exports
+ */
 export class SoundManagerInstance {
     static instance;
     static getInstance() {
@@ -25,7 +31,6 @@ export class SoundManagerInstance {
      *
      * @async
      * @param {Record<string, string>} assets
-     * @returns {Promise<void>}
      */
     async loadSounds(assets) {
         const loadingSoundsPromises = [];
@@ -46,7 +51,7 @@ export class SoundManagerInstance {
         await Promise.all(loadingSoundsPromises);
     }
     /**
-     * Setter for volume level in game
+     * Function for setting volume level for each sound in game
      *
      * @param {number} volumeLevel
      */
@@ -78,23 +83,17 @@ export class SoundManagerInstance {
      * @param {SoundTrack} soundName
      */
     play(soundName) {
-        if (soundName === "music") {
-            if (!RainMan.settingsStore.ambientMusicFlag)
-                return;
-        }
-        else {
-            if (!RainMan.settingsStore.soundFxFlag)
-                return;
-        }
+        if (!RainMan.settingsStore.soundFxFlag)
+            return;
         const overrideSoundName = this.overrides[soundName];
         const sound = overrideSoundName
             ? this.musicCatalogue.get(overrideSoundName)
             : this.musicCatalogue.get(soundName);
         if (!sound)
             return;
-        if (soundName === "music" && sound.isPlaying)
+        if (soundName === "music" && sound.isPlaying && !RainMan.settingsStore.ambientMusicFlag)
             return;
-        sound.play();
+        sound.play({ loop: soundsToLoop.includes(soundName) });
     }
     /**
      * Function for pausing sound with given name

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

@@ -1,3 +1,28 @@
+/**
+ * Object for mapping SoundTracks to appropriate asset.
+ * All properties must be set, if no sound should be played set empty string
+ * @property {string} button - default click button sound
+ * @property {string} deactivationAutostart - click on autostart button
+ * @property {string} increaseRate - click on plus button
+ * @property {string} music - ambient music in loop
+ * @property {string} reductionRate - click on neg button
+ * @property {string} allRollStops - skipping rolling reels, on end
+ * @property {string} bigWin - on show big win popup
+ * @property {string} boom - symbol destroy
+ * @property {string} standaloneBoom - symbol destroy for standalone
+ * @property {string} symbolsFalling - dropping symbols after destroy
+ * @property {string} mysteryFxEnd - on mystery fx hides
+ * @property {string} mysteryFxLoop - when mystery fx in visible in loop
+ * @property {string} line - default win line sound, for both single and multiple lines
+ * @property {string} freeLine - win line sound for free spins
+ * @property {string} mysteryDrawLoop - on show mystery popup, play during randomizing win
+ * @property {string} rollStop - single reel stopping
+ * @property {string} specialSymbolOnReel - single reel stopping with special symbol like bonus or mystery
+ * @property {string} start - on start spinning
+ * @property {string} symbol - on symbol click and show payTable popup
+ *
+ * @exports SoundTracks
+ */
 export declare const SoundTracks: SoundTracks;
 export interface SoundTracks {
     button: "button";
@@ -42,7 +67,12 @@ export type SoundTrack = SoundTracks[keyof SoundTracks];
  * @property {string} rollStop - single reel stopping
  * @property {string} specialSymbolOnReel - single reel stopping with special symbol like bonus or mystery
  * @property {string} start - on start spinning
- * @property {string} symbol - on symbol click and show paytable popup
+ * @property {string} symbol - on symbol click and show payTable popup
  */
 export type GameSoundAssets = Record<SoundTrack, string>;
+/**
+ * Type for overriding sound tracks in game
+ *
+ * @exports SoundOverrides
+ */
 export type SoundOverrides = Partial<Record<SoundTrack, SoundTrack>>;

package/dist/application/SoundManager/types.js

@@ -1,3 +1,28 @@
+/**
+ * Object for mapping SoundTracks to appropriate asset.
+ * All properties must be set, if no sound should be played set empty string
+ * @property {string} button - default click button sound
+ * @property {string} deactivationAutostart - click on autostart button
+ * @property {string} increaseRate - click on plus button
+ * @property {string} music - ambient music in loop
+ * @property {string} reductionRate - click on neg button
+ * @property {string} allRollStops - skipping rolling reels, on end
+ * @property {string} bigWin - on show big win popup
+ * @property {string} boom - symbol destroy
+ * @property {string} standaloneBoom - symbol destroy for standalone
+ * @property {string} symbolsFalling - dropping symbols after destroy
+ * @property {string} mysteryFxEnd - on mystery fx hides
+ * @property {string} mysteryFxLoop - when mystery fx in visible in loop
+ * @property {string} line - default win line sound, for both single and multiple lines
+ * @property {string} freeLine - win line sound for free spins
+ * @property {string} mysteryDrawLoop - on show mystery popup, play during randomizing win
+ * @property {string} rollStop - single reel stopping
+ * @property {string} specialSymbolOnReel - single reel stopping with special symbol like bonus or mystery
+ * @property {string} start - on start spinning
+ * @property {string} symbol - on symbol click and show payTable popup
+ *
+ * @exports SoundTracks
+ */
 export const SoundTracks = {
     button: "button",
     deactivationAutostart: "deactivationAutostart",

package/dist/application/SpeedState/SpeedLevelHandler.d.ts

@@ -1,12 +1,41 @@
 import { SpeedLevel } from "./SpeedLevel";
+/**
+ * Class for handling speed levels
+ *
+ * @export SpeedLevelHandler
+ */
 export declare class SpeedLevelHandler {
     private chosenSpeedLevel;
     private speedLevels;
     static defaultSpeedLevel: SpeedLevel;
+    /**
+     * Function for initializing SpeedLevelHandler with default speed levels
+     *
+     * @returns {SpeedLevelHandler} instance of SpeedLevelHandler with default speed levels
+     */
     static initWithDefaultSpeedLevels(): SpeedLevelHandler;
     constructor(chosenSpeedLevel: number, speedLevels: SpeedLevel[]);
+    /**
+     * Getter for current speed level
+     *
+     * @returns {SpeedLevel} current speed level
+     */
     get currentSpeed(): SpeedLevel;
-    setSpeed(value: SpeedLevel): void;
+    /**
+     * Setter for speed level
+     *
+     * @param newSpeedLevel
+     * @returns
+     */
+    setSpeed(newSpeedLevel: SpeedLevel): void;
+    /**
+     * Function for setting next speed level
+     */
     nextSpeed(): void;
+    /**
+     * Helper function for checking if speed options loop should be reset
+     *
+     * @returns {boolean}
+     */
     private shouldResetSpeedOptionsLoop;
 }

package/dist/application/SpeedState/SpeedLevelHandler.js

@@ -1,8 +1,18 @@
 import { DEFAULT_SPEED, SPEED_LEVELS } from "./SpeedLevel";
+/**
+ * Class for handling speed levels
+ *
+ * @export SpeedLevelHandler
+ */
 export class SpeedLevelHandler {
     chosenSpeedLevel;
     speedLevels;
     static defaultSpeedLevel = DEFAULT_SPEED;
+    /**
+     * Function for initializing SpeedLevelHandler with default speed levels
+     *
+     * @returns {SpeedLevelHandler} instance of SpeedLevelHandler with default speed levels
+     */
     static initWithDefaultSpeedLevels() {
         const defaultSpeedIndex = 0;
         const speedLevels = Object.values(SPEED_LEVELS);
@@ -12,11 +22,22 @@ export class SpeedLevelHandler {
         this.chosenSpeedLevel = chosenSpeedLevel;
         this.speedLevels = speedLevels;
     }
+    /**
+     * Getter for current speed level
+     *
+     * @returns {SpeedLevel} current speed level
+     */
     get currentSpeed() {
         return this.speedLevels[this.chosenSpeedLevel];
     }
-    setSpeed(value) {
-        switch (value) {
+    /**
+     * Setter for speed level
+     *
+     * @param newSpeedLevel
+     * @returns
+     */
+    setSpeed(newSpeedLevel) {
+        switch (newSpeedLevel) {
             case SPEED_LEVELS.slow:
                 this.chosenSpeedLevel = 0;
                 return;
@@ -30,6 +51,9 @@ export class SpeedLevelHandler {
                 throw new Error("No matched speed level");
         }
     }
+    /**
+     * Function for setting next speed level
+     */
     nextSpeed() {
         if (this.shouldResetSpeedOptionsLoop()) {
             this.chosenSpeedLevel = 0;
@@ -37,6 +61,11 @@ export class SpeedLevelHandler {
         }
         this.chosenSpeedLevel += 1;
     }
+    /**
+     * Helper function for checking if speed options loop should be reset
+     *
+     * @returns {boolean}
+     */
     shouldResetSpeedOptionsLoop() {
         return this.chosenSpeedLevel === this.speedLevels.length - 1;
     }

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

@@ -2,6 +2,11 @@ import { SymbolReels, TransformationDetails } from "../../connectivity";
 import { ApiConfig } from "../ApiConfig";
 import { AdaptedSpinResponse } from "./types";
 import { WinScenarios } from "./WinScenarios";
+/**
+ * This class represents mapped data from backend
+ *
+ * @export {SpinLogicDTO}
+ */
 export declare class SpinLogicDTO {
     private rawData;
     private gameConfig;
@@ -15,7 +20,27 @@ export declare class SpinLogicDTO {
     get winScenarios(): WinScenarios[];
     get standaloneTransformations(): TransformationDetails[][];
     get hasMysteryWin(): boolean;
+    /**
+     * Function for mapping the single win from raw backend data
+     *
+     * @param singleWin single win from raw backend data
+     * @param availableFreeSpins number of available free spins (if game have free spins)
+     * @returns {Win} mapped win
+     */
     private getSingleWin;
+    /**
+     * Function for mapping wins from raw backend data
+     *
+     * @param rawData raw data from backend
+     * @param availableFreeSpins number of available free spins (if game have free spins)
+     * @returns {Win[]} mapped array of wins
+     */
     private getWinsFromRawData;
+    /**
+     * Function for converting backend symbol id to frontend symbol id
+     *
+     * @param {string} symbol backend symbol id
+     * @returns {SymbolId} frontend symbol id
+     */
     private stringToSymbolId;
 }

package/dist/application/SpinLogic/SpinLogicDTO.js

@@ -1,6 +1,11 @@
 import { PossibleWins } from "../../constants";
 import { RainMan } from "../../Rainman";
 import { WinScenarios } from "./WinScenarios";
+/**
+ * This class represents mapped data from backend
+ *
+ * @export {SpinLogicDTO}
+ */
 export class SpinLogicDTO {
     rawData;
     gameConfig;
@@ -45,10 +50,7 @@ export class SpinLogicDTO {
         const { results, availableFreeSpins } = this.rawData;
         if (results === undefined)
             return [];
-        return results.map((result) => {
-            const win = this.getWinsFromRawData(result, availableFreeSpins);
-            return new WinScenarios(win, result.transformations);
-        });
+        return results.map((result) => new WinScenarios(this.getWinsFromRawData(result, availableFreeSpins), result.transformations));
     }
     get standaloneTransformations() {
         const { standaloneTransformations } = this.rawData;
@@ -57,10 +59,15 @@ export class SpinLogicDTO {
         return standaloneTransformations;
     }
     get hasMysteryWin() {
-        return this.winScenarios.some((winScenario) => {
-            return winScenario.wins.some((win) => win.type === PossibleWins.mystery);
-        });
+        return this.winScenarios.some((winScenario) => winScenario.wins.some((win) => win.type === PossibleWins.mystery));
     }
+    /**
+     * Function for mapping the single win from raw backend data
+     *
+     * @param singleWin single win from raw backend data
+     * @param availableFreeSpins number of available free spins (if game have free spins)
+     * @returns {Win} mapped win
+     */
     getSingleWin(singleWin, availableFreeSpins) {
         const rawWin = {
             type: this.gameConfig.getWinId(singleWin.typeId),
@@ -78,9 +85,22 @@ export class SpinLogicDTO {
         }
         return rawWin;
     }
+    /**
+     * Function for mapping wins from raw backend data
+     *
+     * @param rawData raw data from backend
+     * @param availableFreeSpins number of available free spins (if game have free spins)
+     * @returns {Win[]} mapped array of wins
+     */
     getWinsFromRawData(rawData, availableFreeSpins) {
         return rawData.wins.map((win) => this.getSingleWin(win, availableFreeSpins));
     }
+    /**
+     * Function for converting backend symbol id to frontend symbol id
+     *
+     * @param {string} symbol backend symbol id
+     * @returns {SymbolId} frontend symbol id
+     */
     stringToSymbolId(symbol) {
         return symbol;
     }

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

@@ -1,4 +1,9 @@
 import { TransformationDetails, Win } from "../../connectivity";
+/**
+ * This class represents win scenarios
+ *
+ * @exports {WinScenarios}
+ */
 export declare class WinScenarios {
     private readonly _wins;
     private readonly _transformations;

package/dist/application/SpinLogic/WinScenarios.js

@@ -1,3 +1,8 @@
+/**
+ * This class represents win scenarios
+ *
+ * @exports {WinScenarios}
+ */
 export class WinScenarios {
     _wins;
     _transformations;

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

@@ -1,7 +1,43 @@
 import { DropTransformationDetails, FreezeTransformationDetails, RawFreezeTransformationDetails, RawWin, Result, SpinAndFreezeTransformationDetails, SpinDataInterface, SymbolReels, TransformationDetails, WinWithTransformation } from "../../connectivity";
 import { ApiConfig } from "../ApiConfig";
+/**
+ * Function to concatenate destroy and set transformations
+ *
+ * @param {SpinDataInterface} spinLogicResponse - parsed response from backend
+ * @param {number} currentIndexOfRootTransformation - index of root transformation
+ * @param {ApiConfig} gameConfig - api configuration
+ * @returns {[DropTransformationDetails[], number]}
+ */
 export declare const concatenateDestroyAndSetTransformations: (spinLogicResponse: SpinDataInterface, currentIndexOfRootTransformation: number, gameConfig: ApiConfig) => [DropTransformationDetails[], number];
+/**
+ * Function to get freeze transformations from raw response
+ *
+ * @param {RawFreezeTransformationDetails[]} transformations
+ * @returns {FreezeTransformationDetails[]}
+ */
 export declare const getFreezeTransformationFromRawResponse: (transformations: RawFreezeTransformationDetails[]) => FreezeTransformationDetails[];
+/**
+ * Function to concatenate freeze and spin transformations
+ *
+ * @param {FreezeTransformationDetails[]} freezeTransformations
+ * @param {SymbolReels} onStopBlindsConfiguration
+ * @returns {SpinAndFreezeTransformationDetails}
+ */
 export declare const concatenateFreezeAndSpinTransformations: (freezeTransformations: FreezeTransformationDetails[], onStopBlindsConfiguration: SymbolReels) => SpinAndFreezeTransformationDetails;
+/**
+ * Function to get vertical transformations from raw response
+ *
+ * @param {Result[]} results
+ * @param {number} transformationTypeId
+ * @returns {number[][] | null}
+ */
 export declare const isBlindsConfiguredByTransformations: (results: Result[], transformationTypeId?: number) => number[][] | null;
+/**
+ * Function for collecting win details with transformation
+ *
+ * @param {RawWin | null} winsDetails
+ * @param {TransformationDetails[]} transformations
+ * @param {string | null} winIndex
+ * @returns {WinWithTransformation}
+ */
 export declare const collectWinDetailsWithTransformation: (winsDetails: RawWin | null, transformations: TransformationDetails[], winIndex?: string | null) => WinWithTransformation;