@gamepark/rules-api 6.24.2 → 6.25.0

package/dist/material/items/MaterialDeck.js

@@ -16,16 +16,49 @@ var __extends = (this && this.__extends) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MaterialDeck = void 0;
-var Material_1 = require("./Material");
-var MaterialDeck = (function (_super) {
+var index_1 = require("./index");
+/**
+ * This subclass of {@link Material} is design to solve one major issue: when creating moves, the material items remains unchanged (Material is immutable),
+ * so you cannot easily deal cards to multiple players at once: you will deal the first X cards all the time if you try to move items multiple time one
+ * the same Material instance.
+ *
+ * MaterialDeck is designed to mutate every time the {@link deal}, {@link dealOne} or {@link dealAtOnce} function are executed, allowing to deal cards
+ * successively to the players, without having to remove the previously dealt card all the time.
+ *
+ * @example
+ * In this example, we deal the first 5 cards to the player 1, then the next 5 cards to player 2.
+ * Using "move" instead of "deal" would give the 5 same cards to both players,
+ * so player 1 would get the cards for a very short time, then player 2 would receive them.
+ * ```
+ * const deck = this.material(MaterialType.Card).deck()
+ * return [
+ *   deck.deal({type: LocationType.PlayerHand, player: player1}, 5)
+ *   deck.deal({type: LocationType.PlayerHand, player: player2}, 5)
+ * ]
+ * ```
+ */
+var MaterialDeck = /** @class */ (function (_super) {
     __extends(MaterialDeck, _super);
     function MaterialDeck() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Prepare moves that will change the location of the first X items AND mutate this MaterialDeck instance to remove the items that will move.
+     *
+     * @param {Location | function} arg The new location of the item. It can be a function to process the location based on the item current state.
+     * @param quantity The number of items to move
+     * @returns {MoveItem[]} the move that will change the location of the item (or a part of its quantity) when executed
+     */
     MaterialDeck.prototype.deal = function (arg, quantity) {
         if (quantity === void 0) { quantity = 1; }
         return this.new(this.entries.splice(0, quantity)).moveItems(arg);
     };
+    /**
+     * Prepare a move that will change the location of the first item AND mutate this MaterialDeck instance to remove this items
+     *
+     * @param {Location | function} arg The new location of the item. It can be a function to process the location based on the item current state.
+     * @returns {MoveItem} the move that will change the location of the item (or a part of its quantity) when executed
+     */
     MaterialDeck.prototype.dealOne = function (arg) {
         var deal = this.deal(arg);
         if (deal.length === 0) {
@@ -38,6 +71,6 @@ var MaterialDeck = (function (_super) {
         return this.new(this.entries.splice(0, quantity)).moveItemsAtOnce(arg);
     };
     return MaterialDeck;
-}(Material_1.Material));
+}(index_1.Material));
 exports.MaterialDeck = MaterialDeck;
 //# sourceMappingURL=MaterialDeck.js.map

package/dist/material/items/MaterialDeck.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialDeck.js","sourceRoot":"","sources":["../../../src/material/items/MaterialDeck.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAEA,uCAAqC;AAuBrC;IAAmH,gCAAiB;IAApI;;IA6BA,CAAC;IArBC,2BAAI,GAAJ,UAAK,GAAoE,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAC7F,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IAClE,CAAC;IAQD,8BAAO,GAAP,UAAQ,GAAoE;QAC1E,IAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC3B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;QACvE,CAAC;QACD,OAAO,IAAI,CAAC,CAAC,CAAC,CAAA;IAChB,CAAC;IAED,iCAAU,GAAV,UAAW,GAAmB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAA;IACxE,CAAC;IACH,mBAAC;AAAD,CAAC,AA7BD,CAAmH,mBAAQ,GA6B1H;AA7BY,oCAAY"}
+{"version":3,"file":"MaterialDeck.js","sourceRoot":"","sources":["../../../src/material/items/MaterialDeck.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAEA,iCAAkC;AAGlC;;;;;;;;;;;;;;;;;;;GAmBG;AACH;IAAmH,gCAAiB;IAApI;;IA6BA,CAAC;IA5BC;;;;;;OAMG;IACH,2BAAI,GAAJ,UAAK,GAAoE,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAC7F,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IAClE,CAAC;IAED;;;;;OAKG;IACH,8BAAO,GAAP,UAAQ,GAAoE;QAC1E,IAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC3B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;QACvE,CAAC;QACD,OAAO,IAAI,CAAC,CAAC,CAAC,CAAA;IAChB,CAAC;IAED,iCAAU,GAAV,UAAW,GAAmB,EAAE,QAAoB;QAApB,yBAAA,EAAA,YAAoB;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAA;IACxE,CAAC;IACH,mBAAC;AAAD,CAAC,AA7BD,CAAmH,gBAAQ,GA6B1H;AA7BY,oCAAY"}

package/dist/material/items/MaterialItem.d.ts

@@ -1,4 +1,16 @@
 import { Location } from '../location';
+/**
+ * A material item is a piece of material in a game
+ *
+ * @typeparam P - identifier of a player. Either a number or a numeric enum (eg: PlayerColor)
+ * @typeparam L - Numeric enum of the types of location in the game where the material can be located
+ * @typeparam Id - Type of id property of the item. Must be JSON serializable.
+ *
+ * @property id Optional item identifier. Meant to identify the item, but not in a unique way. For example, two identical cards in a game should have the same id.
+ * @property quantity Quantity of the item. An item without a quantity will be considered to have a quantity of 1.
+ * @property {Location} location Location of the item in the game (in a player's hand, on the table...). See {@link Location}.
+ * @property {number | boolean | undefined} selected Flag the item if selected. Items with a quantity can be partially selected using a number of select items.
+ */
 export type MaterialItem<P extends number = number, L extends number = number, Id = any> = {
     id?: Id;
     quantity?: number;

package/dist/material/items/MaterialMoney.d.ts

@@ -0,0 +1,81 @@
+import { Location } from '../location';
+import { ItemMove } from '../moves';
+import { ItemEntry, Material } from './index';
+import { MaterialItem } from './MaterialItem';
+/**
+ * This subclass of {@link Material} is design to handle counting and moving Money with different units: coins of 5 and 1 for instance.
+ * It also keeps track of how much money is left after spending moves are create so that it is easy to spend money multiple time at once,
+ * without risking spending the same coins twice because the moves are no immediately executed.
+ */
+export declare class MaterialMoney<P extends number = number, M extends number = number, L extends number = number, Unit extends number = number> extends Material<P, M, L> {
+    readonly type: M;
+    units: Unit[];
+    protected items: MaterialItem<P, L>[];
+    protected readonly processMove?: ((move: ItemMove<P, M, L>) => void) | undefined;
+    entries: ItemEntry<P, L>[];
+    private pendingMoves;
+    /**
+     * Construct a new Material Money helper instance
+     * @param {number} type Type of items this instance will work on
+     * @param {MaterialItem[]} items The complete list of items of this type in current game state.
+     * @param {number[]} units The different units that exists in stock to count this money
+     * @param {ItemEntry[]} entries The list of items to work on. Each entry consists of an array with the index of the item, and the item
+     * @param {function} processMove if provided, this function will be executed on every move created with this instance
+     */
+    constructor(type: M, units: Unit[], items?: MaterialItem<P, L>[], processMove?: ((move: ItemMove<P, M, L>) => void) | undefined, entries?: ItemEntry<P, L>[]);
+    /**
+     * Helper function to return a new instance of the same class (works also for children class)
+     * @param {ItemEntry[]} entries Filtered entries for the new class
+     * @returns {this} the new Material instance
+     * @protected
+     */
+    protected new(entries: ItemEntry<P, L>[]): this;
+    /**
+     * We need to apply the pending moves before any filtering is done to get the right count for instance.
+     */
+    filter(predicate: (item: MaterialItem<P, L>, index: number) => boolean): this;
+    /**
+     * Count the total value of a material instance
+     * @returns the sum of each item id multiplied by its quantity
+     */
+    get count(): number;
+    /**
+     * Create an amount of Money and put it in given location
+     * @param amount Amount to gain
+     * @param location The location to filter material onto, and to create new items in
+     * @returns the moves that need to be played to perform the operation
+     */
+    addMoney(amount: number, location: Location<P, L>): ItemMove<P, M, L>[];
+    /**
+     * Remove an amount of Money from given location
+     * @param amount Amount to spend
+     * @param location The location to filter material onto, and to create new items in
+     * @returns the moves that need to be played to perform the operation
+     */
+    removeMoney(amount: number, location: Location<P, L>): ItemMove<P, M, L>[];
+    /**
+     * Move an amount of money from a place to another place. It searches after the easiest way to do it, making money with the bank only if necessary.
+     * @param origin Location to remove money from
+     * @param target Location to move money to
+     * @param amount Amount of money to transfer
+     * @returns the moves that need to be played to perform the operation
+     */
+    moveMoney(origin: Location<P, L>, target: Location<P, L>, amount: number): ItemMove<P, M, L>[];
+    /**
+     * Return the best way to gain an amount, prioritizing the highest unit values
+     * @param amount Amount to gain, default 1
+     * @returns the record of coins to earn (only positive values)
+     */
+    private getGainMap;
+    /**
+     * Return the best way to spend an amount of owned units, prioritizing the smallest unit values
+     * @param amount Amount to gain, default 1
+     * @returns the record of coins to give away and eventually take (positive and negative values)
+     */
+    private getSpendMap;
+    /**
+     * Mutate the entries to get the state after
+     * @private
+     */
+    private applyPendingMoves;
+}

package/dist/material/items/MaterialMoney.js

@@ -0,0 +1,288 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaterialMoney = void 0;
+var lodash_1 = require("lodash");
+var isEqual_1 = __importDefault(require("lodash/isEqual"));
+var keyBy_1 = __importDefault(require("lodash/keyBy"));
+var mapValues_1 = __importDefault(require("lodash/mapValues"));
+var sumBy_1 = __importDefault(require("lodash/sumBy"));
+var index_1 = require("./index");
+var MaterialMutator_1 = require("./MaterialMutator");
+/**
+ * This subclass of {@link Material} is design to handle counting and moving Money with different units: coins of 5 and 1 for instance.
+ * It also keeps track of how much money is left after spending moves are create so that it is easy to spend money multiple time at once,
+ * without risking spending the same coins twice because the moves are no immediately executed.
+ */
+var MaterialMoney = /** @class */ (function (_super) {
+    __extends(MaterialMoney, _super);
+    /**
+     * Construct a new Material Money helper instance
+     * @param {number} type Type of items this instance will work on
+     * @param {MaterialItem[]} items The complete list of items of this type in current game state.
+     * @param {number[]} units The different units that exists in stock to count this money
+     * @param {ItemEntry[]} entries The list of items to work on. Each entry consists of an array with the index of the item, and the item
+     * @param {function} processMove if provided, this function will be executed on every move created with this instance
+     */
+    function MaterialMoney(type, units, items, processMove, entries) {
+        if (items === void 0) { items = []; }
+        if (entries === void 0) { entries = Array.from(items.entries()).filter(function (entry) { return entry[1].quantity !== 0; }); }
+        var _this = _super.call(this, type, items, processMove, entries) || this;
+        _this.type = type;
+        _this.units = units;
+        _this.items = items;
+        _this.processMove = processMove;
+        _this.entries = entries;
+        _this.pendingMoves = [];
+        if (_this.units[0] === 1) {
+            _this.units = __spreadArray([], units, true);
+            _this.units.sort(function (a, b) { return b - a; }); // Sort units from highest to 1
+        }
+        if (_this.units[_this.units.length - 1] !== 1)
+            console.warn('Money without 1 in the possible values will produce unexpected outcomes');
+        return _this;
+    }
+    /**
+     * Helper function to return a new instance of the same class (works also for children class)
+     * @param {ItemEntry[]} entries Filtered entries for the new class
+     * @returns {this} the new Material instance
+     * @protected
+     */
+    MaterialMoney.prototype.new = function (entries) {
+        var Class = this.constructor;
+        return new Class(this.type, this.units, this.items, this.processMove, entries);
+    };
+    /**
+     * We need to apply the pending moves before any filtering is done to get the right count for instance.
+     */
+    MaterialMoney.prototype.filter = function (predicate) {
+        this.applyPendingMoves();
+        return _super.prototype.filter.call(this, predicate);
+    };
+    Object.defineProperty(MaterialMoney.prototype, "count", {
+        /**
+         * Count the total value of a material instance
+         * @returns the sum of each item id multiplied by its quantity
+         */
+        get: function () {
+            this.applyPendingMoves();
+            return (0, sumBy_1.default)(this.getItems(), function (item) { var _a, _b; return ((_a = item.id) !== null && _a !== void 0 ? _a : 1) * ((_b = item.quantity) !== null && _b !== void 0 ? _b : 1); });
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Create an amount of Money and put it in given location
+     * @param amount Amount to gain
+     * @param location The location to filter material onto, and to create new items in
+     * @returns the moves that need to be played to perform the operation
+     */
+    MaterialMoney.prototype.addMoney = function (amount, location) {
+        var _a;
+        if (amount === 0)
+            return [];
+        if (amount < 0)
+            return this.removeMoney(-amount, location);
+        var moves = [];
+        var gainMap = this.getGainMap(amount);
+        for (var _i = 0, _b = this.units; _i < _b.length; _i++) {
+            var unit = _b[_i];
+            if (gainMap[unit] > 0) {
+                moves.push(this.createItem({ id: unit, location: location, quantity: gainMap[unit] }));
+            }
+        }
+        (_a = this.pendingMoves).push.apply(_a, moves);
+        return moves;
+    };
+    /**
+     * Remove an amount of Money from given location
+     * @param amount Amount to spend
+     * @param location The location to filter material onto, and to create new items in
+     * @returns the moves that need to be played to perform the operation
+     */
+    MaterialMoney.prototype.removeMoney = function (amount, location) {
+        var _a;
+        if (amount === 0)
+            return [];
+        if (amount < 0)
+            return this.addMoney(-amount, location);
+        this.applyPendingMoves();
+        if (this.entries.some(function (_a) {
+            var item = _a[1];
+            return !(0, isEqual_1.default)(item.location, location);
+        })) {
+            return this.location(function (l) { return (0, isEqual_1.default)(l, location); }).removeMoney(amount, location);
+        }
+        var moves = [];
+        var spendMap = this.getSpendMap(amount);
+        for (var _i = 0, _b = this.units; _i < _b.length; _i++) {
+            var unit = _b[_i];
+            if (spendMap[unit] < 0) {
+                moves.push(this.id(unit).deleteItem(-spendMap[unit]));
+            }
+            else if (spendMap[unit] > 0) {
+                moves.push(this.createItem({ id: unit, location: location, quantity: spendMap[unit] }));
+            }
+        }
+        (_a = this.pendingMoves).push.apply(_a, moves);
+        return moves;
+    };
+    /**
+     * Move an amount of money from a place to another place. It searches after the easiest way to do it, making money with the bank only if necessary.
+     * @param origin Location to remove money from
+     * @param target Location to move money to
+     * @param amount Amount of money to transfer
+     * @returns the moves that need to be played to perform the operation
+     */
+    MaterialMoney.prototype.moveMoney = function (origin, target, amount) {
+        var _a;
+        if (amount === 0)
+            return [];
+        if (amount < 0)
+            return this.moveMoney(target, origin, -amount);
+        this.applyPendingMoves();
+        var moves = [];
+        var originMoney = this.location(function (l) { return (0, isEqual_1.default)(l, origin); });
+        var targetMoney = this.location(function (l) { return (0, isEqual_1.default)(l, target); });
+        var originDelta = originMoney.getSpendMap(amount);
+        var targetDelta = targetMoney.getGainMap(amount);
+        for (var _i = 0, _b = this.units; _i < _b.length; _i++) {
+            var unit = _b[_i];
+            if (originDelta[unit] < 0) {
+                var _loop_1 = function () {
+                    var lowerUnits = this_1.units.slice(this_1.units.indexOf(unit) + 1);
+                    var targetResultDelta = targetMoney.getSpendMap(unit);
+                    var valueSpent = (0, sumBy_1.default)(lowerUnits, function (unit) { return -targetResultDelta[unit] * unit; });
+                    if (valueSpent === unit && lowerUnits.every(function (lowerUnit) { return targetResultDelta[lowerUnit] < 0; })) {
+                        targetDelta[unit]++;
+                        for (var _c = 0, lowerUnits_1 = lowerUnits; _c < lowerUnits_1.length; _c++) {
+                            var lowerUnit = lowerUnits_1[_c];
+                            targetDelta[lowerUnit] += targetResultDelta[lowerUnit];
+                        }
+                    }
+                    else
+                        return "break";
+                };
+                var this_1 = this;
+                while (targetDelta[unit] < -originDelta[unit]) {
+                    var state_1 = _loop_1();
+                    if (state_1 === "break")
+                        break;
+                }
+                var moveAmount = Math.min(-originDelta[unit], targetDelta[unit]);
+                targetDelta[unit] -= moveAmount;
+                var originMaterialUnit = originMoney.id(unit);
+                if (moveAmount > 0) {
+                    moves.push(originMaterialUnit.moveItem(target, moveAmount));
+                }
+                if (moveAmount < -originDelta[unit]) {
+                    moves.push(originMaterialUnit.deleteItem(-originDelta[unit] - moveAmount));
+                }
+            }
+            else if (originDelta[unit] > 0) {
+                if (targetDelta[unit] < 0) {
+                    moves.push(targetMoney.id(unit).moveItem(origin, -targetDelta[unit]));
+                }
+                else {
+                    moves.push(originMoney.createItem({ id: unit, location: origin, quantity: originDelta[unit] }));
+                }
+            }
+            if (targetDelta[unit] > 0) {
+                moves.push(targetMoney.createItem({ id: unit, location: target, quantity: targetDelta[unit] }));
+            }
+        }
+        (_a = this.pendingMoves).push.apply(_a, moves);
+        return moves;
+    };
+    /**
+     * Return the best way to gain an amount, prioritizing the highest unit values
+     * @param amount Amount to gain, default 1
+     * @returns the record of coins to earn (only positive values)
+     */
+    MaterialMoney.prototype.getGainMap = function (amount) {
+        var map = (0, mapValues_1.default)((0, keyBy_1.default)(this.units), function (_) { return 0; });
+        for (var _i = 0, _a = this.units; _i < _a.length; _i++) {
+            var unit = _a[_i];
+            map[unit] = Math.floor(amount / unit);
+            amount %= unit;
+        }
+        return map;
+    };
+    /**
+     * Return the best way to spend an amount of owned units, prioritizing the smallest unit values
+     * @param amount Amount to gain, default 1
+     * @returns the record of coins to give away and eventually take (positive and negative values)
+     */
+    MaterialMoney.prototype.getSpendMap = function (amount) {
+        var _this = this;
+        var owned = (0, mapValues_1.default)((0, keyBy_1.default)(this.units), function (unit) { return _this.id(unit).getQuantity(); });
+        var map = (0, mapValues_1.default)((0, keyBy_1.default)(this.units), function (_) { return 0; });
+        for (var _1 = 0; _1 < amount; _1++) {
+            for (var i = this.units.length - 1; i >= 0; i--) {
+                var unit = this.units[i];
+                if (owned[unit] + map[unit] > 0) {
+                    map[unit]--;
+                    if (unit > 1) {
+                        var rest = unit - 1;
+                        for (var _i = 0, _a = this.units.slice(i + 1); _i < _a.length; _i++) {
+                            var lowerUnit = _a[_i];
+                            if (lowerUnit <= rest) {
+                                map[lowerUnit] += Math.floor(rest / lowerUnit);
+                                rest -= rest % lowerUnit;
+                            }
+                        }
+                    }
+                    break;
+                }
+            }
+        }
+        return map;
+    };
+    /**
+     * Mutate the entries to get the state after
+     * @private
+     */
+    MaterialMoney.prototype.applyPendingMoves = function () {
+        var _this = this;
+        if (!this.pendingMoves.length)
+            return;
+        if (this.items.some(function (item, index) { return item.quantity !== 0 && !_this.entries.some(function (entry) { return entry[0] === index; }); })) {
+            console.warn('MaterialMoney cannot track the state of the items on filtered instances, the filter will be cancelled');
+        }
+        this.items = (0, lodash_1.cloneDeep)(this.items);
+        var mutator = new MaterialMutator_1.MaterialMutator(this.type, this.items);
+        while (this.pendingMoves.length > 0) {
+            mutator.applyMove(this.pendingMoves.shift());
+        }
+        this.entries = Array.from(this.items.entries()).filter(function (entry) { return entry[1].quantity !== 0; });
+    };
+    return MaterialMoney;
+}(index_1.Material));
+exports.MaterialMoney = MaterialMoney;
+//# sourceMappingURL=MaterialMoney.js.map

package/dist/material/items/MaterialMoney.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MaterialMoney.js","sourceRoot":"","sources":["../../../src/material/items/MaterialMoney.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iCAAkC;AAClC,2DAAoC;AACpC,uDAAgC;AAChC,+DAAwC;AACxC,uDAAgC;AAGhC,iCAA6C;AAE7C,qDAAmD;AAEnD;;;;GAIG;AACH;IACU,iCAAiB;IAGzB;;;;;;;OAOG;IACH,uBACW,IAAO,EACT,KAAa,EACV,KAAgC,EACvB,WAA+C,EAC3D,OAAiG;QAF9F,sBAAA,EAAA,UAAgC;QAEnC,wBAAA,EAAA,UAA6B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,EAAvB,CAAuB,CAAC;QAExG,YAAA,MAAK,YAAC,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,SAAA;QAN/B,UAAI,GAAJ,IAAI,CAAG;QACT,WAAK,GAAL,KAAK,CAAQ;QACV,WAAK,GAAL,KAAK,CAA2B;QACvB,iBAAW,GAAX,WAAW,CAAoC;QAC3D,aAAO,GAAP,OAAO,CAA0F;QAflG,kBAAY,GAAwB,EAAE,CAAA;QAkB5C,IAAI,KAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,KAAI,CAAC,KAAK,qBAAO,KAAK,OAAC,CAAA;YACvB,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,GAAG,CAAC,EAAL,CAAK,CAAC,CAAA,CAAC,+BAA+B;QAClE,CAAC;QACD,IAAI,KAAI,CAAC,KAAK,CAAC,KAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAA;;IACtI,CAAC;IAED;;;;;OAKG;IACO,2BAAG,GAAb,UAAc,OAA0B;QACtC,IAAM,KAAK,GAAG,IAAI,CAAC,WAA8J,CAAA;QACjL,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAA;IAChF,CAAC;IAED;;OAEG;IACH,8BAAM,GAAN,UAAO,SAA+D;QACpE,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,gBAAK,CAAC,MAAM,YAAC,SAAS,CAAC,CAAA;IAChC,CAAC;IAMD,sBAAI,gCAAK;QAJT;;;WAGG;aACH;YACE,IAAI,CAAC,iBAAiB,EAAE,CAAA;YACxB,OAAO,IAAA,eAAK,EAAC,IAAI,CAAC,QAAQ,EAAQ,EAAE,UAAA,IAAI,gBAAI,OAAA,CAAC,MAAA,IAAI,CAAC,EAAE,mCAAI,CAAC,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAI,CAAC,CAAC,CAAA,EAAA,CAAC,CAAA;QACpF,CAAC;;;OAAA;IAED;;;;;OAKG;IACH,gCAAQ,GAAR,UAAS,MAAc,EAAE,QAAwB;;QAC/C,IAAI,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAA;QAC3B,IAAI,MAAM,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QAC1D,IAAM,KAAK,GAAwB,EAAE,CAAA;QACrC,IAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACvC,KAAmB,UAAU,EAAV,KAAA,IAAI,CAAC,KAAK,EAAV,cAAU,EAAV,IAAU,EAAE,CAAC;YAA3B,IAAM,IAAI,SAAA;YACb,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,UAAA,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;YAC9E,CAAC;QACH,CAAC;QACD,CAAA,KAAA,IAAI,CAAC,YAAY,CAAA,CAAC,IAAI,WAAI,KAAK,EAAC;QAChC,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,mCAAW,GAAX,UAAY,MAAc,EAAE,QAAwB;;QAClD,IAAI,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAA;QAC3B,IAAI,MAAM,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QACvD,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAC,EAAQ;gBAAL,IAAI,QAAA;YAAM,OAAA,CAAC,IAAA,iBAAO,EAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAAjC,CAAiC,CAAC,EAAE,CAAC;YACvE,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAA,CAAC,IAAI,OAAA,IAAA,iBAAO,EAAC,CAAC,EAAE,QAAQ,CAAC,EAApB,CAAoB,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QAC/E,CAAC;QACD,IAAM,KAAK,GAAwB,EAAE,CAAA;QACrC,IAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QACzC,KAAmB,UAAU,EAAV,KAAA,IAAI,CAAC,KAAK,EAAV,cAAU,EAAV,IAAU,EAAE,CAAC;YAA3B,IAAM,IAAI,SAAA;YACb,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACvD,CAAC;iBAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,UAAA,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;YAC/E,CAAC;QACH,CAAC;QACD,CAAA,KAAA,IAAI,CAAC,YAAY,CAAA,CAAC,IAAI,WAAI,KAAK,EAAC;QAChC,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,iCAAS,GAAT,UAAU,MAAsB,EAAE,MAAsB,EAAE,MAAc;;QACtE,IAAI,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAA;QAC3B,IAAI,MAAM,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,CAAA;QAC9D,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,IAAM,KAAK,GAAwB,EAAE,CAAA;QACrC,IAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAA,CAAC,IAAI,OAAA,IAAA,iBAAO,EAAC,CAAC,EAAE,MAAM,CAAC,EAAlB,CAAkB,CAAC,CAAA;QAC1D,IAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAA,CAAC,IAAI,OAAA,IAAA,iBAAO,EAAC,CAAC,EAAE,MAAM,CAAC,EAAlB,CAAkB,CAAC,CAAA;QAC1D,IAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QACnD,IAAM,WAAW,GAAG,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAClD,KAAmB,UAAU,EAAV,KAAA,IAAI,CAAC,KAAK,EAAV,cAAU,EAAV,IAAU,EAAE,CAAC;YAA3B,IAAM,IAAI,SAAA;YACb,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;;oBAExB,IAAM,UAAU,GAAG,OAAK,KAAK,CAAC,KAAK,CAAC,OAAK,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;oBACjE,IAAM,iBAAiB,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;oBACvD,IAAM,UAAU,GAAG,IAAA,eAAK,EAAC,UAAU,EAAE,UAAA,IAAI,IAAI,OAAA,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,IAAI,EAA/B,CAA+B,CAAC,CAAA;oBAC7E,IAAI,UAAU,KAAK,IAAI,IAAI,UAAU,CAAC,KAAK,CAAC,UAAA,SAAS,IAAI,OAAA,iBAAiB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAhC,CAAgC,CAAC,EAAE,CAAC;wBAC3F,WAAW,CAAC,IAAI,CAAC,EAAE,CAAA;wBACnB,KAAwB,UAAU,EAAV,yBAAU,EAAV,wBAAU,EAAV,IAAU,EAAE,CAAC;4BAAhC,IAAM,SAAS,mBAAA;4BAClB,WAAW,CAAC,SAAS,CAAC,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAA;wBACxD,CAAC;oBACH,CAAC;;uCAAW;;;gBATd,OAAO,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;;;;iBAU5C;gBACD,IAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;gBAClE,WAAW,CAAC,IAAI,CAAC,IAAI,UAAU,CAAA;gBAC/B,IAAM,kBAAkB,GAAG,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;gBAC/C,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;oBACnB,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAA;gBAC7D,CAAC;gBACD,IAAI,UAAU,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAA;gBAC5E,CAAC;YACH,CAAC;iBAAM,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACvE,CAAC;qBAAM,CAAC;oBACN,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;gBACjG,CAAC;YACH,CAAC;YACD,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;YACjG,CAAC;QACH,CAAC;QACD,CAAA,KAAA,IAAI,CAAC,YAAY,CAAA,CAAC,IAAI,WAAI,KAAK,EAAC;QAChC,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACK,kCAAU,GAAlB,UAAmB,MAAc;QAC/B,IAAM,GAAG,GAAG,IAAA,mBAAS,EAAC,IAAA,eAAK,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAA,CAAC,IAAI,OAAA,CAAC,EAAD,CAAC,CAAC,CAAA;QAChD,KAAmB,UAAU,EAAV,KAAA,IAAI,CAAC,KAAK,EAAV,cAAU,EAAV,IAAU,EAAE,CAAC;YAA3B,IAAM,IAAI,SAAA;YACb,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;YACrC,MAAM,IAAI,IAAI,CAAA;QAChB,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;OAIG;IACK,mCAAW,GAAnB,UAAoB,MAAc;QAAlC,iBAsBC;QArBC,IAAM,KAAK,GAAG,IAAA,mBAAS,EAAC,IAAA,eAAK,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAA3B,CAA2B,CAAC,CAAA;QAC/E,IAAM,GAAG,GAAG,IAAA,mBAAS,EAAC,IAAA,eAAK,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAA,CAAC,IAAI,OAAA,CAAC,EAAD,CAAC,CAAC,CAAA;QAChD,KAAK,IAAI,EAAC,GAAG,CAAC,EAAE,EAAC,GAAG,MAAM,EAAE,EAAC,EAAE,EAAE,CAAC;YAChC,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAChD,IAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC1B,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAA;oBACX,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;wBACb,IAAI,IAAI,GAAG,IAAI,GAAG,CAAC,CAAA;wBACnB,KAAwB,UAAuB,EAAvB,KAAA,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAvB,cAAuB,EAAvB,IAAuB,EAAE,CAAC;4BAA7C,IAAM,SAAS,SAAA;4BAClB,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;gCACtB,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,CAAA;gCAC9C,IAAI,IAAI,IAAI,GAAG,SAAS,CAAA;4BAC1B,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,MAAK;gBACP,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;OAGG;IACK,yCAAiB,GAAzB;QAAA,iBAWC;QAVC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM;YAAE,OAAM;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAC,IAAI,EAAE,KAAK,IAAK,OAAA,IAAI,CAAC,QAAQ,KAAK,CAAC,IAAI,CAAC,KAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,EAAlB,CAAkB,CAAC,EAAtE,CAAsE,CAAC,EAAE,CAAC;YAC7G,OAAO,CAAC,IAAI,CAAC,uGAAuG,CAAC,CAAA;QACvH,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAClC,IAAM,OAAO,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QAC1D,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAG,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,EAAvB,CAAuB,CAAC,CAAA;IAC1F,CAAC;IACH,oBAAC;AAAD,CAAC,AArND,CACU,gBAAQ,GAoNjB;AArNY,sCAAa"}

package/dist/material/items/MaterialMutator.d.ts

@@ -1,15 +1,43 @@
 import { LocationStrategy } from '../location';
 import { ItemMoveRandomized, ItemMoveView, MoveItem, MoveItemsAtOnce } from '../moves';
 import { MaterialItem } from './index';
+/**
+ * Helper class to change the state of any {@link MaterialItem} in a game implemented with {@link MaterialRules}.
+ *
+ * @typeparam P - identifier of a player. Either a number or a numeric enum (eg: PlayerColor)
+ * @typeparam M - Numeric enum of the types of material manipulated in the game
+ * @typeparam L - Numeric enum of the types of location in the game where the material can be located
+ */
 export declare class MaterialMutator<P extends number = number, M extends number = number, L extends number = number> {
     private readonly type;
     private readonly items;
     private readonly locationsStrategies;
     private readonly canMerge;
+    /**
+     * @param type Type of items this mutator will work on
+     * @param items Items to work with
+     * @param locationsStrategies The strategies that these items must follow
+     * @param canMerge Whether to items at the exact same location can merge into one item with a quantity
+     */
     constructor(type: M, items: MaterialItem<P, L>[], locationsStrategies?: Partial<Record<L, LocationStrategy<P, M, L>>>, canMerge?: boolean);
+    /**
+     * Executes a move on the game items
+     * @param move
+     */
     applyMove(move: ItemMoveRandomized<P, M, L> | ItemMoveView<P, M, L>): void;
+    /**
+     * Find the index of an existing item we could merge a new item with (create a single item with a quantity)
+     *
+     * @param newItem An item to compare with existing items
+     * @returns {number} Index of the existing item we can merge with, or -1 if there is no possible merge
+     */
     findMergeIndex(newItem: MaterialItem<P, L>): number;
     private addItem;
+    /**
+     * Provides the index that the new item will have
+     * @param newItem An item that is going to be created
+     * @returns {number} the future index of that item
+     */
     getItemCreationIndex(newItem: MaterialItem<P, L>): number;
     private applyAddItemStrategy;
     private applyMoveItemStrategy;
@@ -20,7 +48,18 @@ export declare class MaterialMutator<P extends number = number, M extends number
     private roll;
     private moveItem;
     private moveItemsAtOnce;
+    /**
+     * Provides the state of an item after it is moved
+     * @param move The move that is going to happen
+     * @return {MaterialItem} state of the item after the move is executed
+     */
     getItemAfterMove(move: MoveItem<P, M, L>): MaterialItem<P, L>;
+    /**
+     * Provides the state of an item after it is moved
+     * @param move The move that is going to happen
+     * @param index Index of the item to consider
+     * @return {MaterialItem} state of the item after the move is executed
+     */
     getItemAfterMoveAtOnce(move: MoveItemsAtOnce<P, M, L>, index: number): MaterialItem<P, L>;
     private getItemWithLocation;
     private delete;

package/dist/material/items/MaterialMutator.js

@@ -31,7 +31,20 @@ var merge_1 = __importDefault(require("lodash/merge"));
 var location_1 = require("../location");
 var moves_1 = require("../moves");
 var index_1 = require("./index");
-var MaterialMutator = (function () {
+/**
+ * Helper class to change the state of any {@link MaterialItem} in a game implemented with {@link MaterialRules}.
+ *
+ * @typeparam P - identifier of a player. Either a number or a numeric enum (eg: PlayerColor)
+ * @typeparam M - Numeric enum of the types of material manipulated in the game
+ * @typeparam L - Numeric enum of the types of location in the game where the material can be located
+ */
+var MaterialMutator = /** @class */ (function () {
+    /**
+     * @param type Type of items this mutator will work on
+     * @param items Items to work with
+     * @param locationsStrategies The strategies that these items must follow
+     * @param canMerge Whether to items at the exact same location can merge into one item with a quantity
+     */
     function MaterialMutator(type, items, locationsStrategies, canMerge) {
         if (locationsStrategies === void 0) { locationsStrategies = {}; }
         if (canMerge === void 0) { canMerge = true; }
@@ -40,6 +53,10 @@ var MaterialMutator = (function () {
         this.locationsStrategies = locationsStrategies;
         this.canMerge = canMerge;
     }
+    /**
+     * Executes a move on the game items
+     * @param move
+     */
     MaterialMutator.prototype.applyMove = function (move) {
         switch (move.type) {
             case moves_1.ItemMoveType.Create:
@@ -77,6 +94,12 @@ var MaterialMutator = (function () {
                 break;
         }
     };
+    /**
+     * Find the index of an existing item we could merge a new item with (create a single item with a quantity)
+     *
+     * @param newItem An item to compare with existing items
+     * @returns {number} Index of the existing item we can merge with, or -1 if there is no possible merge
+     */
     MaterialMutator.prototype.findMergeIndex = function (newItem) {
         if (!this.canMerge)
             return -1;
@@ -96,6 +119,11 @@ var MaterialMutator = (function () {
             this.items.push(item);
         }
     };
+    /**
+     * Provides the index that the new item will have
+     * @param newItem An item that is going to be created
+     * @returns {number} the future index of that item
+     */
     MaterialMutator.prototype.getItemCreationIndex = function (newItem) {
         var mergeIndex = this.findMergeIndex(newItem);
         if (mergeIndex !== -1)
@@ -109,7 +137,7 @@ var MaterialMutator = (function () {
         if (item.location.type in this.locationsStrategies) {
             var strategy = this.locationsStrategies[item.location.type];
             if (strategy.addItem) {
-                var material = new index_1.Material(this.type, Array.from(this.items.entries()).filter(function (entry) { return entry[1].quantity !== 0; }))
+                var material = new index_1.Material(this.type, this.items)
                     .location(item.location.type).player(item.location.player).locationId(item.location.id).parent(item.location.parent);
                 strategy.addItem(material, item);
             }
@@ -119,7 +147,7 @@ var MaterialMutator = (function () {
         if (item.location.type in this.locationsStrategies) {
             var strategy = this.locationsStrategies[item.location.type];
             if (strategy.moveItem) {
-                var material = new index_1.Material(this.type, Array.from(this.items.entries()).filter(function (entry) { return entry[1].quantity !== 0; }))
+                var material = new index_1.Material(this.type, this.items)
                     .location(item.location.type).player(item.location.player).locationId(item.location.id).parent(item.location.parent);
                 strategy.moveItem(material, item, index);
             }
@@ -137,7 +165,7 @@ var MaterialMutator = (function () {
         if (item.location.type in this.locationsStrategies) {
             var strategy = this.locationsStrategies[item.location.type];
             if (strategy.removeItem) {
-                var material = new index_1.Material(this.type, Array.from(this.items.entries()).filter(function (entry) { return entry[1].quantity !== 0; }))
+                var material = new index_1.Material(this.type, this.items)
                     .location(item.location.type).player(item.location.player).locationId(item.location.id).parent(item.location.parent);
                 strategy.removeItem(material, item);
             }
@@ -212,6 +240,11 @@ var MaterialMutator = (function () {
             }
         }
     };
+    /**
+     * Provides the state of an item after it is moved
+     * @param move The move that is going to happen
+     * @return {MaterialItem} state of the item after the move is executed
+     */
     MaterialMutator.prototype.getItemAfterMove = function (move) {
         var item = this.getItemWithLocation(move.location, move.itemIndex);
         if (move.reveal) {
@@ -225,6 +258,12 @@ var MaterialMutator = (function () {
         }
         return item;
     };
+    /**
+     * Provides the state of an item after it is moved
+     * @param move The move that is going to happen
+     * @param index Index of the item to consider
+     * @return {MaterialItem} state of the item after the move is executed
+     */
     MaterialMutator.prototype.getItemAfterMoveAtOnce = function (move, index) {
         var item = this.getItemWithLocation(move.location, index);
         if (move.reveal && move.reveal[index]) {
@@ -244,7 +283,7 @@ var MaterialMutator = (function () {
     MaterialMutator.prototype.shuffle = function (move) {
         var _this = this;
         if (!(0, moves_1.isShuffleRandomized)(move))
-            return;
+            return; // Nothing to do on front-end side for a shuffle. The index swap is only required on the backend.
         var shuffledItems = move.indexes.map(function (index) { return _this.items[index]; });
         move.newIndexes.forEach(function (newIndex, i) {
             _this.items[newIndex] = __assign(__assign({}, shuffledItems[i]), { location: _this.items[newIndex].location });