@gamepark/rules-api 6.24.2 → 6.24.3

package/dist/material/MaterialGameSetup.js

@@ -5,17 +5,33 @@ var utils_1 = require("../utils");
 var items_1 = require("./items");
 var memory_1 = require("./memory");
 var moves_1 = require("./moves");
-var MaterialGameSetup = (function () {
+/**
+ * Helper class to implement {@link GameSetup} when using the {@link MaterialRules} approach.
+ */
+var MaterialGameSetup = /** @class */ (function () {
     function MaterialGameSetup() {
+        /**
+         * The game setup state we are working on
+         * @protected
+         */
         this.game = { players: [], items: {}, memory: {} };
     }
     Object.defineProperty(MaterialGameSetup.prototype, "rules", {
+        /**
+         * Get an instance of the rules of the game
+         */
         get: function () {
             return new this.Rules(this.game);
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * Entry point for {@link GameSetup}
+     * @param options Options of the game
+     * @param tutorial Initial tutorial state if any
+     * @returns the initial state of the game
+     */
     MaterialGameSetup.prototype.setup = function (options, tutorial) {
         this.game = { players: getPlayerIds(options), items: {}, memory: {}, tutorial: tutorial };
         this.setupMaterial(options);
@@ -23,14 +39,31 @@ var MaterialGameSetup = (function () {
         return this.game;
     };
     Object.defineProperty(MaterialGameSetup.prototype, "players", {
+        /**
+         * @returns array of the player ids (shortcut for this.game.players)
+         */
         get: function () {
             return this.game.players;
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * Override this function if you need to set up some material before the game starts. Called by {@link setup}.
+     * @param _options Options of the game
+     */
     MaterialGameSetup.prototype.setupMaterial = function (_options) {
     };
+    /**
+     * Help function to execute a move immediately on the game state.
+     * When the game is on, the moves should never be played directly: the framework takes care of playing the moves when necessary
+     * (on te server, on the clients, during replays...).
+     * However, during the setup, the moves must be played immediately in the game state to provide the initial game state to the framework.
+     * This help function allows to easily play a {@link MaterialMove}, using the rules provided in {@link Rules}, including the consequences.
+     *
+     * @param move The MaterialMove to play
+     * @protected
+     */
     MaterialGameSetup.prototype.playMove = function (move) {
         if ((0, utils_1.hasRandomMove)(this.rules)) {
             move = this.rules.randomize(move);
@@ -38,6 +71,11 @@ var MaterialGameSetup = (function () {
         var consequences = this.rules.play(JSON.parse(JSON.stringify(move)));
         (0, utils_1.applyAutomaticMoves)(this.rules, consequences);
     };
+    /**
+     * Helper function to manipulate the items of the game. See {@link Material}.
+     * @param type The type of Material we want to work on
+     * @returns a Material instance to manipulate all the material of that type in current game state.
+     */
     MaterialGameSetup.prototype.material = function (type) {
         var _this = this;
         if (!this.game.items[type])
@@ -45,19 +83,47 @@ var MaterialGameSetup = (function () {
         var items = this.game.items[type];
         return new items_1.Material(type, Array.from(items.entries()).filter(function (entry) { return entry[1].quantity !== 0; }), function (move) { return _this.playMove(move); });
     };
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     MaterialGameSetup.prototype.getMemory = function (player) {
         return player === undefined ? new memory_1.GameMemory(this.game) : new memory_1.PlayerMemory(this.game, player);
     };
+    /**
+     * Helper function to memorize some information that does not fit in an item or the rules state, in the game state
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param value Value to memorize
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     MaterialGameSetup.prototype.memorize = function (key, value, player) {
         this.getMemory(player).memorize(key, value);
     };
+    /**
+     * Helper function to play a {@link StartPlayerTurn} move on the game setup state.
+     * @param id Rule id to start
+     * @param player Player that starts the game (default value: this.game.players[0])
+     */
     MaterialGameSetup.prototype.startPlayerTurn = function (id, player) {
         if (player === void 0) { player = this.game.players[0]; }
         this.playMove(moves_1.MaterialMoveBuilder.startPlayerTurn(id, player));
     };
+    /**
+     * Helper function to play a {@link StartSimultaneousRule} move on the game setup state.
+     * @param id Rule id to start
+     * @param players Players that are active (all the players by default)
+     */
     MaterialGameSetup.prototype.startSimultaneousRule = function (id, players) {
         this.playMove(moves_1.MaterialMoveBuilder.startSimultaneousRule(id, players));
     };
+    /**
+     * Helper function to play a {@link StartRule} move on the game setup state.
+     * @param id Rule id to start
+     */
     MaterialGameSetup.prototype.startRule = function (id) {
         this.playMove(moves_1.MaterialMoveBuilder.startRule(id));
     };

package/dist/material/MaterialGameSetup.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialGameSetup.js","sourceRoot":"","sources":["../../src/material/MaterialGameSetup.ts"],"names":[],"mappings":";;;AACA,kCAA6D;AAC7D,iCAAkC;AAGlC,mCAAmD;AACnD,iCAA2D;AAM3D;IAAA;QAYY,SAAI,GAA0B,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IAuHhF,CAAC;IAlHC,sBAAI,oCAAK;aAAT;YACE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC;;;OAAA;IAQD,iCAAK,GAAL,UAAM,OAAgB,EAAE,QAAwB;QAC9C,IAAI,CAAC,IAAI,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,UAAA,EAAE,CAAA;QAC/E,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACnB,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAKD,sBAAI,sCAAO;aAAX;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC1B,CAAC;;;OAAA;IAMD,yCAAa,GAAb,UAAc,QAAiB;IAC/B,CAAC;IAYS,oCAAQ,GAAlB,UAAmB,IAA2B;QAC5C,IAAI,IAAA,qBAAa,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QACD,IAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACtE,IAAA,2BAAmB,EAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAC/C,CAAC;IAOD,oCAAQ,GAAR,UAAS,IAAO;QAAhB,iBAIC;QAHC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QACtD,IAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAE,CAAA;QACpC,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,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,EAAE,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAA;IAC9H,CAAC;IAUS,qCAAS,GAAnB,UAAoB,MAAU;QAC5B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/F,CAAC;IAQD,oCAAQ,GAAR,UAAkB,GAAc,EAAE,KAAgC,EAAE,MAAU;QAC5E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC7C,CAAC;IAcD,2CAAe,GAAf,UAAgD,EAAU,EAAE,MAAgC;QAAhC,uBAAA,EAAA,SAAY,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAChE,CAAC;IAOD,iDAAqB,GAArB,UAAsD,EAAU,EAAE,OAAa;QAC7E,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAA;IACvE,CAAC;IAMD,qCAAS,GAAT,UAA0C,EAAU;QAClD,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAA;IAClD,CAAC;IACH,wBAAC;AAAD,CAAC,AAnID,IAmIC;AAnIqB,8CAAiB;AAqIvC,SAAS,YAAY,CAAiC,OAAY;;IAChE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnC,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,MAAW,EAAE,KAAa,YAAK,OAAA,MAAA,MAAM,CAAC,EAAE,mCAAI,KAAK,GAAG,CAAC,CAAA,EAAA,CAAC,CAAA;IACpF,CAAC;SAAM,CAAC;QACN,IAAM,eAAe,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,CAAC,CAAA;QAC5C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,CAAC,KAAK,GAAG,CAAC,CAAW,EAArB,CAAqB,CAAC,CAAA;IACtF,CAAC;AACH,CAAC"}
+{"version":3,"file":"MaterialGameSetup.js","sourceRoot":"","sources":["../../src/material/MaterialGameSetup.ts"],"names":[],"mappings":";;;AACA,kCAA6D;AAC7D,iCAAkC;AAGlC,mCAAmD;AACnD,iCAA2D;AAG3D;;GAEG;AACH;IAAA;QAQE;;;WAGG;QACO,SAAI,GAA0B,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IAuHhF,CAAC;IAlHC,sBAAI,oCAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC;;;OAAA;IAED;;;;;OAKG;IACH,iCAAK,GAAL,UAAM,OAAgB,EAAE,QAAwB;QAC9C,IAAI,CAAC,IAAI,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,UAAA,EAAE,CAAA;QAC/E,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACnB,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAKD,sBAAI,sCAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC1B,CAAC;;;OAAA;IAED;;;OAGG;IACH,yCAAa,GAAb,UAAc,QAAiB;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACO,oCAAQ,GAAlB,UAAmB,IAA2B;QAC5C,IAAI,IAAA,qBAAa,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QACD,IAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACtE,IAAA,2BAAmB,EAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAC/C,CAAC;IAED;;;;OAIG;IACH,oCAAQ,GAAR,UAAS,IAAO;QAAhB,iBAIC;QAHC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QACtD,IAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAE,CAAA;QACpC,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,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,EAAE,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAA;IAC9H,CAAC;IAED;;;;;;;OAOG;IACO,qCAAS,GAAnB,UAAoB,MAAU;QAC5B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/F,CAAC;IAED;;;;;OAKG;IACH,oCAAQ,GAAR,UAAkB,GAAc,EAAE,KAAgC,EAAE,MAAU;QAC5E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC7C,CAAC;IASD;;;;OAIG;IACH,2CAAe,GAAf,UAAgD,EAAU,EAAE,MAAgC;QAAhC,uBAAA,EAAA,SAAY,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAChE,CAAC;IAED;;;;OAIG;IACH,iDAAqB,GAArB,UAAsD,EAAU,EAAE,OAAa;QAC7E,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAA;IACvE,CAAC;IAED;;;OAGG;IACH,qCAAS,GAAT,UAA0C,EAAU;QAClD,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAA;IAClD,CAAC;IACH,wBAAC;AAAD,CAAC,AAnID,IAmIC;AAnIqB,8CAAiB;AAqIvC,SAAS,YAAY,CAAiC,OAAY;;IAChE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnC,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,MAAW,EAAE,KAAa,YAAK,OAAA,MAAA,MAAM,CAAC,EAAE,mCAAI,KAAK,GAAG,CAAC,CAAA,EAAA,CAAC,CAAA;IACpF,CAAC;SAAM,CAAC;QACN,IAAM,eAAe,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,CAAC,CAAA;QAC5C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,CAAC,KAAK,GAAG,CAAC,CAAW,EAArB,CAAqB,CAAC,CAAA;IACtF,CAAC;AACH,CAAC"}

package/dist/material/MaterialRules.d.ts

@@ -9,30 +9,155 @@ import { MaterialGame } from './MaterialGame';
 import { GameMemory, PlayerMemory } from './memory';
 import { MaterialMove, MaterialMoveRandomized, MaterialMoveView, RollItem } from './moves';
 import { MaterialRulesPart, MaterialRulesPartCreator } from './rules';
+/**
+ * The MaterialRules class is the main class to implement the rules of a board game with the "Material oriented" approach.
+ * With this approach, the game state and the game moves is structured around the game material items and their movements.
+ * The rules are also automatically split into small parts.
+ * Finally, a "memory" util is available to store temporary information which is not part of the material or the rules state.
+ * If you need to implement game with hidden information, see {@link HiddenMaterialRules} or {@link SecretMaterialRules}.
+ *
+ * @typeparam Player - identifier of a player. Either a number or a numeric enum (eg: PlayerColor)
+ * @typeparam MaterialType - Numeric enum of the types of material manipulated in the game
+ * @typeparam LocationType - Numeric enum of the types of location in the game where the material can be located
+ */
 export declare abstract class MaterialRules<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> extends Rules<MaterialGame<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> implements RandomMove<MaterialMove<Player, MaterialType, LocationType>, MaterialMoveRandomized<Player, MaterialType, LocationType>>, Undo<MaterialMove<Player, MaterialType, LocationType>, Player>, UnpredictableMoves<MaterialMove<Player, MaterialType, LocationType>> {
+    /**
+     * When you implement a game using the "material" approach, you are also strongly advised to split the rules of the game into many small parts.
+     * You should usually create a numeric enum class "RuleId" that will list all those small parts.
+     * This "rules" property must be implemented to map each "rule id" with the corresponding MaterialRulesPart class.
+     * This way, the behavior of the rules can be delegated to the corresponding rule part at each step of the game.
+     */
     abstract readonly rules: Record<number, MaterialRulesPartCreator<Player, MaterialType, LocationType>>;
+    /**
+     * The "location strategies" are global rules that always apply in a game when we want to maintain a consistency in the position of the material.
+     * For example, we usually want the cards in a player hand to always go from x=0 to x=n without a gap, so we use a {@link PositiveSequenceStrategy} to enforce
+     * the rule once and for all. If we want to create a "river" of card we can use a {@link FillGapStrategy}.
+     * Games with more complex use cases can implement their own {@link LocationStrategy}.
+     */
     readonly locationsStrategies: Partial<Record<MaterialType, Partial<Record<LocationType, LocationStrategy<Player, MaterialType, LocationType>>>>>;
+    /**
+     * Helper function to manipulate the material items of the game. See {@link Material}.
+     *
+     * @param type The type of Material we want to work on
+     * @returns a Material instance to manipulate all the material of that type in current game state.
+     */
     material(type: MaterialType): Material<Player, MaterialType, LocationType>;
+    /**
+     * Shortcut for this.game.players
+     * @returns array of the players identifiers
+     */
     get players(): Player[];
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     protected getMemory(player?: Player): GameMemory<Player> | PlayerMemory<Player>;
+    /**
+     * Retrieve the value memorized under a given key.
+     * Shortcut for this.game.memory[key] or this.game.memory[key][player]
+     *
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     remind<T = any>(key: keyof any, player?: Player): T;
+    /**
+     * Instantiates the class that handled the rules of the game corresponding to the current rule id.
+     * This function reads the current value in this.game.rule.id and instantiate the corresponding class in the {@link rules} property.
+     *
+     * @returns the class that handled the rules of the game, at current specific game state.
+     */
     get rulesStep(): MaterialRulesPart<Player, MaterialType, LocationType> | undefined;
+    /**
+     * Returns a utility class to change the state of the items.
+     * Used by the framework to apply the Material moves on the items (should not be manipulated directly in the games).
+     *
+     * @param type MaterialType of the item we want to modify
+     * @returns a MaterialMutator to change the state of the items
+     */
     mutator(type: MaterialType): MaterialMutator<Player, MaterialType, LocationType>;
+    /**
+     * Items can sometime be stored with a quantity (for example, coins).
+     * By default, if you create or move similar items to the exact same location, they will merge into one item with a quantity.
+     * However, if you have 2 cards that can be at the same spot for a short time (swapping or replacing), you can override this function to prevent them to merge
+     *
+     * @param _type type of items
+     * @returns true if items can merge into one item with a quantity (default behavior)
+     */
     itemsCanMerge(_type: MaterialType): boolean;
+    /**
+     * In the material approach, the rules behavior is delegated to the current {@link rulesStep}. See {@link Rules.delegate}
+     */
     delegate(): Rules<MaterialGame<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> | undefined;
+    /**
+     * Randomize Shuffle of Roll moves (see {@link RandomMove.randomize})
+     * @param move The Material Move to randomize
+     * @returns the randomized move
+     */
     randomize(move: MaterialMove<Player, MaterialType, LocationType>): MaterialMove<Player, MaterialType, LocationType> & MaterialMoveRandomized<Player, MaterialType, LocationType>;
+    /**
+     * When a RollItem move is create, it has to be randomized on the server side before it is saved and shared.
+     * This function provides the random value. By default, it returns a value between 0 and 5 assuming a 6 sided dice is rolled.
+     * If you need to flip a coin or roll non-cubic dice, you need to override this function.
+     *
+     * @param _move The RollItem move to randomize
+     * @returns a random rolled value, by default a value between 0 and 5 (cubic dice result)
+     */
     roll(_move: RollItem<Player, MaterialType, LocationType>): number;
+    /**
+     * Execution of the Material Moves. See {@link Rules.play}.
+     *
+     * @param move Material move to play on the game state
+     * @param context Context in which the move was played
+     * @returns Consequences of the move
+     */
     play(move: MaterialMoveRandomized<Player, MaterialType, LocationType> | MaterialMoveView<Player, MaterialType, LocationType>, context?: PlayMoveContext): MaterialMove<Player, MaterialType, LocationType>[];
     private changeRule;
+    /**
+     * By default, a Material Move can be undone if no player became active and no dice was rolled.
+     * See {@link Undo.canUndo} and {@link HiddenMaterialRules.canUndo}
+     *
+     * @param action Action to consider
+     * @param consecutiveActions Action played in between
+     * @returns true if the action can be undone by the player that played it
+     */
     canUndo(action: Action<MaterialMove<Player, MaterialType, LocationType>, Player>, consecutiveActions: Action<MaterialMove<Player, MaterialType, LocationType>, Player>[]): boolean;
     private consecutiveActionBlocksUndo;
     private actionBlocksUndo;
     private actionActivatesPlayer;
+    /**
+     * @protected
+     * If a moves blocks the undo, any action with this move cannot be undone.
+     * By default, a move block the undo if it activates a player or exposes new information (roll result, hidden information revealed...)
+     *
+     * @param move The move to consider
+     * @returns true if the move blocks the undo
+     */
     protected moveBlocksUndo(move: MaterialMove<Player, MaterialType, LocationType>): boolean;
     private moveActivatesPlayer;
+    /**
+     * Random moves, or moves that reveals something to me, are unpredictable.
+     * Unpredictable moves cannot be precomputed on client side, the server side's response is necessary.
+     * See {@link Rules.isUnpredictableMove}
+     *
+     * @param move Material move to consider
+     * @param _player The player playing the move
+     * @returns true if the move outcome cannot be predicted on client side
+     */
     isUnpredictableMove(move: MaterialMove<Player, MaterialType, LocationType>, _player: Player): boolean;
+    /**
+     * A Material Game is over when there is no rule left to execute. This state results of a {@link EndGame} move.
+     *
+     * @returns true if game is over
+     */
     isOver(): boolean;
 }
+/**
+ * Signature interface of the constructor of a class that implements MaterialRules
+ */
 export interface MaterialRulesCreator<P extends number = number, M extends number = number, L extends number = number> {
     new (state: MaterialGame<P, M, L>, client?: {
         player?: P;

package/dist/material/MaterialRules.js

@@ -37,31 +37,79 @@ var items_1 = require("./items");
 var memory_1 = require("./memory");
 var moves_1 = require("./moves");
 var rules_1 = require("./rules");
-var MaterialRules = (function (_super) {
+/**
+ * The MaterialRules class is the main class to implement the rules of a board game with the "Material oriented" approach.
+ * With this approach, the game state and the game moves is structured around the game material items and their movements.
+ * The rules are also automatically split into small parts.
+ * Finally, a "memory" util is available to store temporary information which is not part of the material or the rules state.
+ * If you need to implement game with hidden information, see {@link HiddenMaterialRules} or {@link SecretMaterialRules}.
+ *
+ * @typeparam Player - identifier of a player. Either a number or a numeric enum (eg: PlayerColor)
+ * @typeparam MaterialType - Numeric enum of the types of material manipulated in the game
+ * @typeparam LocationType - Numeric enum of the types of location in the game where the material can be located
+ */
+var MaterialRules = /** @class */ (function (_super) {
     __extends(MaterialRules, _super);
     function MaterialRules() {
         var _this = _super !== null && _super.apply(this, arguments) || this;
+        /**
+         * The "location strategies" are global rules that always apply in a game when we want to maintain a consistency in the position of the material.
+         * For example, we usually want the cards in a player hand to always go from x=0 to x=n without a gap, so we use a {@link PositiveSequenceStrategy} to enforce
+         * the rule once and for all. If we want to create a "river" of card we can use a {@link FillGapStrategy}.
+         * Games with more complex use cases can implement their own {@link LocationStrategy}.
+         */
         _this.locationsStrategies = {};
         return _this;
     }
+    /**
+     * Helper function to manipulate the material items of the game. See {@link Material}.
+     *
+     * @param type The type of Material we want to work on
+     * @returns a Material instance to manipulate all the material of that type in current game state.
+     */
     MaterialRules.prototype.material = function (type) {
         var _a;
         return new items_1.Material(type, Array.from(((_a = this.game.items[type]) !== null && _a !== void 0 ? _a : []).entries()).filter(function (entry) { return entry[1].quantity !== 0; }));
     };
     Object.defineProperty(MaterialRules.prototype, "players", {
+        /**
+         * Shortcut for this.game.players
+         * @returns array of the players identifiers
+         */
         get: function () {
             return this.game.players;
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     MaterialRules.prototype.getMemory = function (player) {
         return player === undefined ? new memory_1.GameMemory(this.game) : new memory_1.PlayerMemory(this.game, player);
     };
+    /**
+     * Retrieve the value memorized under a given key.
+     * Shortcut for this.game.memory[key] or this.game.memory[key][player]
+     *
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     MaterialRules.prototype.remind = function (key, player) {
         return this.getMemory(player).remind(key);
     };
     Object.defineProperty(MaterialRules.prototype, "rulesStep", {
+        /**
+         * Instantiates the class that handled the rules of the game corresponding to the current rule id.
+         * This function reads the current value in this.game.rule.id and instantiate the corresponding class in the {@link rules} property.
+         *
+         * @returns the class that handled the rules of the game, at current specific game state.
+         */
         get: function () {
             if (!this.game.rule)
                 return;
@@ -75,16 +123,39 @@ var MaterialRules = (function (_super) {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Returns a utility class to change the state of the items.
+     * Used by the framework to apply the Material moves on the items (should not be manipulated directly in the games).
+     *
+     * @param type MaterialType of the item we want to modify
+     * @returns a MaterialMutator to change the state of the items
+     */
     MaterialRules.prototype.mutator = function (type) {
         var _a;
         return new items_1.MaterialMutator(type, (_a = this.game.items[type]) !== null && _a !== void 0 ? _a : [], this.locationsStrategies[type], this.itemsCanMerge(type));
     };
+    /**
+     * Items can sometime be stored with a quantity (for example, coins).
+     * By default, if you create or move similar items to the exact same location, they will merge into one item with a quantity.
+     * However, if you have 2 cards that can be at the same spot for a short time (swapping or replacing), you can override this function to prevent them to merge
+     *
+     * @param _type type of items
+     * @returns true if items can merge into one item with a quantity (default behavior)
+     */
     MaterialRules.prototype.itemsCanMerge = function (_type) {
         return true;
     };
+    /**
+     * In the material approach, the rules behavior is delegated to the current {@link rulesStep}. See {@link Rules.delegate}
+     */
     MaterialRules.prototype.delegate = function () {
         return this.rulesStep;
     };
+    /**
+     * Randomize Shuffle of Roll moves (see {@link RandomMove.randomize})
+     * @param move The Material Move to randomize
+     * @returns the randomized move
+     */
     MaterialRules.prototype.randomize = function (move) {
         if ((0, moves_1.isShuffle)(move)) {
             return __assign(__assign({}, move), { newIndexes: (0, shuffle_1.default)(move.indexes) });
@@ -94,9 +165,24 @@ var MaterialRules = (function (_super) {
         }
         return move;
     };
+    /**
+     * When a RollItem move is create, it has to be randomized on the server side before it is saved and shared.
+     * This function provides the random value. By default, it returns a value between 0 and 5 assuming a 6 sided dice is rolled.
+     * If you need to flip a coin or roll non-cubic dice, you need to override this function.
+     *
+     * @param _move The RollItem move to randomize
+     * @returns a random rolled value, by default a value between 0 and 5 (cubic dice result)
+     */
     MaterialRules.prototype.roll = function (_move) {
         return (0, random_1.default)(5);
     };
+    /**
+     * Execution of the Material Moves. See {@link Rules.play}.
+     *
+     * @param move Material move to play on the game state
+     * @param context Context in which the move was played
+     * @returns Consequences of the move
+     */
     MaterialRules.prototype.play = function (move, context) {
         var _a, _b;
         var consequences = [];
@@ -181,6 +267,14 @@ var MaterialRules = (function (_super) {
         }
         return moves.concat((_f = (_e = this.rulesStep) === null || _e === void 0 ? void 0 : _e.onRuleStart(move, rule, context)) !== null && _f !== void 0 ? _f : []);
     };
+    /**
+     * By default, a Material Move can be undone if no player became active and no dice was rolled.
+     * See {@link Undo.canUndo} and {@link HiddenMaterialRules.canUndo}
+     *
+     * @param action Action to consider
+     * @param consecutiveActions Action played in between
+     * @returns true if the action can be undone by the player that played it
+     */
     MaterialRules.prototype.canUndo = function (action, consecutiveActions) {
         for (var i = consecutiveActions.length - 1; i >= 0; i--) {
             if (this.consecutiveActionBlocksUndo(action, consecutiveActions[i])) {
@@ -216,15 +310,37 @@ var MaterialRules = (function (_super) {
         }
         return this.moveActivatesPlayer(action.move);
     };
+    /**
+     * @protected
+     * If a moves blocks the undo, any action with this move cannot be undone.
+     * By default, a move block the undo if it activates a player or exposes new information (roll result, hidden information revealed...)
+     *
+     * @param move The move to consider
+     * @returns true if the move blocks the undo
+     */
     MaterialRules.prototype.moveBlocksUndo = function (move) {
         return this.moveActivatesPlayer(move) || (0, moves_1.isRoll)(move);
     };
     MaterialRules.prototype.moveActivatesPlayer = function (move) {
         return (0, moves_1.isStartPlayerTurn)(move) || (0, moves_1.isStartSimultaneousRule)(move);
     };
+    /**
+     * Random moves, or moves that reveals something to me, are unpredictable.
+     * Unpredictable moves cannot be precomputed on client side, the server side's response is necessary.
+     * See {@link Rules.isUnpredictableMove}
+     *
+     * @param move Material move to consider
+     * @param _player The player playing the move
+     * @returns true if the move outcome cannot be predicted on client side
+     */
     MaterialRules.prototype.isUnpredictableMove = function (move, _player) {
         return (0, moves_1.isRoll)(move);
     };
+    /**
+     * A Material Game is over when there is no rule left to execute. This state results of a {@link EndGame} move.
+     *
+     * @returns true if game is over
+     */
     MaterialRules.prototype.isOver = function () {
         return !this.game.rule;
     };

package/dist/material/MaterialRules.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialRules.js","sourceRoot":"","sources":["../../src/material/MaterialRules.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAkC;AAClC,2DAAoC;AAGpC,kCAAiD;AAGjD,iCAAmD;AAGnD,mCAAmD;AACnD,iCAgBgB;AAChB,iCAAyF;AAazF;IACU,iCAAiH;IAD3H;;QAqBW,yBAAmB,GAAuH,EAAE,CAAA;;IAuSvJ,CAAC;IA/RC,gCAAQ,GAAR,UAAS,IAAkB;;QACzB,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,EAAvB,CAAuB,CAAC,CAAC,CAAA;IACzH,CAAC;IAMD,sBAAI,kCAAO;aAAX;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC1B,CAAC;;;OAAA;IAUS,iCAAS,GAAnB,UAAoB,MAAe;QACjC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAS,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAS,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/G,CAAC;IASD,8BAAM,GAAN,UAAgB,GAAc,EAAE,MAAe;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC3C,CAAC;IAQD,sBAAI,oCAAS;aAAb;YACE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAM;YAC3B,IAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAC/C,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,uCAAgC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,gBAAa,CAAC,CAAA;gBAC7E,OAAM;YACR,CAAC;YACD,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjC,CAAC;;;OAAA;IASD,+BAAO,GAAP,UAAQ,IAAkB;;QACxB,OAAO,IAAI,uBAAe,CAAC,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAI,EAAE,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAA;IACzH,CAAC;IAUD,qCAAa,GAAb,UAAc,KAAmB;QAC/B,OAAO,IAAI,CAAA;IACb,CAAC;IAKD,gCAAQ,GAAR;QACE,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAOD,iCAAS,GAAT,UACE,IAAsD;QAEtD,IAAI,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE,CAAC;YACpB,6BAAY,IAAI,KAAE,UAAU,EAAE,IAAA,iBAAO,EAAC,IAAI,CAAC,OAAO,CAAC,IAAE;QACvD,CAAC;aAAM,IAAI,IAAA,cAAM,EAAC,IAAI,CAAC,EAAE,CAAC;YACxB,6BAAY,IAAI,KAAE,QAAQ,wBAAO,IAAI,CAAC,QAAQ,KAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAI;QAC/E,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAUD,4BAAI,GAAJ,UAAK,KAAmD;QACtD,OAAO,IAAA,gBAAM,EAAC,CAAC,CAAC,CAAA;IAClB,CAAC;IASD,4BAAI,GAAJ,UACE,IAAuH,EAAE,OAAyB;;QAGlJ,IAAM,YAAY,GAAuD,EAAE,CAAA;QAC3E,IAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAChC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,gBAAQ,CAAC,QAAQ;gBACpB,IAAI,SAAS,EAAE,CAAC;oBACd,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBAC/D,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;oBAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAA;gBACxE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAC3C,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;gBACvB,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAA,oBAAY,EAAC,IAAI,CAAC,CAAC;uBAChE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;oBACpG,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAA;gBAC9B,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBAC9D,CAAC;gBACD,MAAK;YACP,KAAK,gBAAQ,CAAC,SAAS;gBACrB,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAY,CAAC,aAAa,EAAE,CAAC;oBAC7C,IAAI,MAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,OAAO,0CAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;wBACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAA,MAAM,IAAI,OAAA,MAAM,KAAK,IAAI,CAAC,MAAM,EAAtB,CAAsB,CAAC,CAAA;wBACxF,IAAI,IAAA,0BAAkB,EAAC,SAAS,CAAC,EAAE,CAAC;4BAClC,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;4BAC9D,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gCACxC,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,wBAAwB,EAAE,EAAC;4BAC5D,CAAC;wBACH,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,OAAO,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAA;oBACpF,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBACtD,CAAC;gBACD,MAAK;YACP,KAAK,gBAAQ,CAAC,UAAU;gBACtB,IAAI,SAAS,EAAE,CAAC;oBACd,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBAC7D,CAAC;gBACD,MAAK;YACP,KAAK,gBAAQ,CAAC,SAAS;gBACrB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBAClB,KAAK,qBAAa,CAAC,WAAW;wBAC5B,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;wBACxC,MAAK;oBACP,KAAK,qBAAa,CAAC,QAAQ;wBACzB,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAA;wBACjC,MAAK;oBACP,KAAK,qBAAa,CAAC,eAAe;wBAChC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;wBACpC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,YAAY,GAAG,KAAK,CAAA;wBACxC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,WAAW,GAAG,KAAK,CAAA;wBACvC,MAAK;oBACP,KAAK,qBAAa,CAAC,kBAAkB;wBACnC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,WAAW,GAAG,IAAI,CAAA;gBAC1C,CAAC;QACL,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAEO,kCAAU,GAAlB,UAAmB,IAAsB,EAAE,OAAyB;;QAClE,IAAM,KAAK,GAAG,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,mCAAI,EAAE,CAAA;QAC5D,IAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;QAC3B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,oBAAY,CAAC,eAAe;gBAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAA;gBACrD,MAAK;YACP,KAAK,oBAAY,CAAC,qBAAqB;gBACrC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAA;gBAC5E,MAAK;YACP,KAAK,oBAAY,CAAC,SAAS;gBACzB,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,MAAM,EAAE,CAAA;gBAChE,MAAK;YACP,KAAK,oBAAY,CAAC,OAAO;gBACvB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;gBACrB,MAAK;QACT,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,mCAAI,EAAE,CAAC,CAAA;IAC7E,CAAC;IAUD,+BAAO,GAAP,UAAQ,MAAwE,EACxE,kBAAsF;QAC5F,KAAK,IAAI,CAAC,GAAG,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACxD,IAAI,IAAI,CAAC,2BAA2B,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpE,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACvC,CAAC;IAEO,mDAA2B,GAAnC,UAAoC,MAAwE,EAChF,iBAAmF;QAC7G,IAAI,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAClD,OAAO,IAAI,CAAA;QACb,CAAC;QACD,IAAI,iBAAiB,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,EAAE,CAAC;YACnD,IAAI,CAAC,IAAA,oBAAY,EAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,oBAAY,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxE,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,wCAAgB,GAAxB,UAAyB,MAAwE;QAC/F,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzD,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChD,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACzC,CAAC;IAEO,6CAAqB,GAA7B,UAA8B,MAAwE;QACpG,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzD,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;IAUS,sCAAc,GAAxB,UAAyB,IAAsD;QAC7E,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAA,cAAM,EAAC,IAAI,CAAC,CAAA;IACvD,CAAC;IAEO,2CAAmB,GAA3B,UAA4B,IAAsD;QAChF,OAAO,IAAA,yBAAiB,EAAC,IAAI,CAAC,IAAI,IAAA,+BAAuB,EAAC,IAAI,CAAC,CAAA;IACjE,CAAC;IAWD,2CAAmB,GAAnB,UAAoB,IAAsD,EAAE,OAAe;QACzF,OAAO,IAAA,cAAM,EAAC,IAAI,CAAC,CAAA;IACrB,CAAC;IAOD,8BAAM,GAAN;QACE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;IACxB,CAAC;IACH,oBAAC;AAAD,CAAC,AA5TD,CACU,aAAK,GA2Td;AA5TqB,sCAAa"}
+{"version":3,"file":"MaterialRules.js","sourceRoot":"","sources":["../../src/material/MaterialRules.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAkC;AAClC,2DAAoC;AAGpC,kCAAiD;AAGjD,iCAAmD;AAGnD,mCAAmD;AACnD,iCAgBgB;AAChB,iCAAyF;AAEzF;;;;;;;;;;GAUG;AACH;IACU,iCAAiH;IAD3H;;QAeE;;;;;WAKG;QACM,yBAAmB,GAAuH,EAAE,CAAA;;IAuSvJ,CAAC;IArSC;;;;;OAKG;IACH,gCAAQ,GAAR,UAAS,IAAkB;;QACzB,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,EAAvB,CAAuB,CAAC,CAAC,CAAA;IACzH,CAAC;IAMD,sBAAI,kCAAO;QAJX;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC1B,CAAC;;;OAAA;IAED;;;;;;;OAOG;IACO,iCAAS,GAAnB,UAAoB,MAAe;QACjC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAS,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAS,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/G,CAAC;IAED;;;;;;OAMG;IACH,8BAAM,GAAN,UAAgB,GAAc,EAAE,MAAe;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC3C,CAAC;IAQD,sBAAI,oCAAS;QANb;;;;;WAKG;aACH;YACE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAM;YAC3B,IAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAC/C,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,uCAAgC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,gBAAa,CAAC,CAAA;gBAC7E,OAAM;YACR,CAAC;YACD,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjC,CAAC;;;OAAA;IAED;;;;;;OAMG;IACH,+BAAO,GAAP,UAAQ,IAAkB;;QACxB,OAAO,IAAI,uBAAe,CAAC,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAI,EAAE,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAA;IACzH,CAAC;IAED;;;;;;;OAOG;IACH,qCAAa,GAAb,UAAc,KAAmB;QAC/B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,gCAAQ,GAAR;QACE,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED;;;;OAIG;IACH,iCAAS,GAAT,UACE,IAAsD;QAEtD,IAAI,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE,CAAC;YACpB,6BAAY,IAAI,KAAE,UAAU,EAAE,IAAA,iBAAO,EAAC,IAAI,CAAC,OAAO,CAAC,IAAE;QACvD,CAAC;aAAM,IAAI,IAAA,cAAM,EAAC,IAAI,CAAC,EAAE,CAAC;YACxB,6BAAY,IAAI,KAAE,QAAQ,wBAAO,IAAI,CAAC,QAAQ,KAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAI;QAC/E,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,4BAAI,GAAJ,UAAK,KAAmD;QACtD,OAAO,IAAA,gBAAM,EAAC,CAAC,CAAC,CAAA;IAClB,CAAC;IAED;;;;;;OAMG;IACH,4BAAI,GAAJ,UACE,IAAuH,EAAE,OAAyB;;QAGlJ,IAAM,YAAY,GAAuD,EAAE,CAAA;QAC3E,IAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAChC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,gBAAQ,CAAC,QAAQ;gBACpB,IAAI,SAAS,EAAE,CAAC;oBACd,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBAC/D,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;oBAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAA;gBACxE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAC3C,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;gBACvB,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAA,oBAAY,EAAC,IAAI,CAAC,CAAC;uBAChE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;oBACpG,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAA;gBAC9B,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBAC9D,CAAC;gBACD,MAAK;YACP,KAAK,gBAAQ,CAAC,SAAS;gBACrB,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAY,CAAC,aAAa,EAAE,CAAC;oBAC7C,IAAI,MAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,OAAO,0CAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;wBACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAA,MAAM,IAAI,OAAA,MAAM,KAAK,IAAI,CAAC,MAAM,EAAtB,CAAsB,CAAC,CAAA;wBACxF,IAAI,IAAA,0BAAkB,EAAC,SAAS,CAAC,EAAE,CAAC;4BAClC,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;4BAC9D,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gCACxC,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,wBAAwB,EAAE,EAAC;4BAC5D,CAAC;wBACH,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,OAAO,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAA;oBACpF,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBACtD,CAAC;gBACD,MAAK;YACP,KAAK,gBAAQ,CAAC,UAAU;gBACtB,IAAI,SAAS,EAAE,CAAC;oBACd,YAAY,CAAC,IAAI,OAAjB,YAAY,EAAS,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EAAC;gBAC7D,CAAC;gBACD,MAAK;YACP,KAAK,gBAAQ,CAAC,SAAS;gBACrB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBAClB,KAAK,qBAAa,CAAC,WAAW;wBAC5B,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;wBACxC,MAAK;oBACP,KAAK,qBAAa,CAAC,QAAQ;wBACzB,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAA;wBACjC,MAAK;oBACP,KAAK,qBAAa,CAAC,eAAe;wBAChC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;wBACpC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,YAAY,GAAG,KAAK,CAAA;wBACxC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,WAAW,GAAG,KAAK,CAAA;wBACvC,MAAK;oBACP,KAAK,qBAAa,CAAC,kBAAkB;wBACnC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,WAAW,GAAG,IAAI,CAAA;gBAC1C,CAAC;QACL,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAEO,kCAAU,GAAlB,UAAmB,IAAsB,EAAE,OAAyB;;QAClE,IAAM,KAAK,GAAG,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,mCAAI,EAAE,CAAA;QAC5D,IAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;QAC3B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,oBAAY,CAAC,eAAe;gBAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAA;gBACrD,MAAK;YACP,KAAK,oBAAY,CAAC,qBAAqB;gBACrC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAA;gBAC5E,MAAK;YACP,KAAK,oBAAY,CAAC,SAAS;gBACzB,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,MAAM,EAAE,CAAA;gBAChE,MAAK;YACP,KAAK,oBAAY,CAAC,OAAO;gBACvB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;gBACrB,MAAK;QACT,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,mCAAI,EAAE,CAAC,CAAA;IAC7E,CAAC;IAED;;;;;;;OAOG;IACH,+BAAO,GAAP,UAAQ,MAAwE,EACxE,kBAAsF;QAC5F,KAAK,IAAI,CAAC,GAAG,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACxD,IAAI,IAAI,CAAC,2BAA2B,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpE,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACvC,CAAC;IAEO,mDAA2B,GAAnC,UAAoC,MAAwE,EAChF,iBAAmF;QAC7G,IAAI,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAClD,OAAO,IAAI,CAAA;QACb,CAAC;QACD,IAAI,iBAAiB,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,EAAE,CAAC;YACnD,IAAI,CAAC,IAAA,oBAAY,EAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,oBAAY,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxE,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,wCAAgB,GAAxB,UAAyB,MAAwE;QAC/F,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzD,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChD,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACzC,CAAC;IAEO,6CAAqB,GAA7B,UAA8B,MAAwE;QACpG,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzD,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;OAOG;IACO,sCAAc,GAAxB,UAAyB,IAAsD;QAC7E,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAA,cAAM,EAAC,IAAI,CAAC,CAAA;IACvD,CAAC;IAEO,2CAAmB,GAA3B,UAA4B,IAAsD;QAChF,OAAO,IAAA,yBAAiB,EAAC,IAAI,CAAC,IAAI,IAAA,+BAAuB,EAAC,IAAI,CAAC,CAAA;IACjE,CAAC;IAED;;;;;;;;OAQG;IACH,2CAAmB,GAAnB,UAAoB,IAAsD,EAAE,OAAe;QACzF,OAAO,IAAA,cAAM,EAAC,IAAI,CAAC,CAAA;IACrB,CAAC;IAED;;;;OAIG;IACH,8BAAM,GAAN;QACE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;IACxB,CAAC;IACH,oBAAC;AAAD,CAAC,AA5TD,CACU,aAAK,GA2Td;AA5TqB,sCAAa"}

package/dist/material/SecretMaterialRules.d.ts

@@ -3,11 +3,42 @@ import { HiddenMaterialRules, HidingStrategy } from './HiddenMaterialRules';
 import { MaterialItem } from './items';
 import { MaterialGame } from './MaterialGame';
 import { MaterialMove, MaterialMoveRandomized } from './moves';
+/**
+ * Implement SecretMaterialRules when you want to use the {@link MaterialRules} approach with {@link SecretInformation}.
+ * Using some {@link HidingSecretsStrategy} allows to enforce the security of a game with secret information easily.
+ * If the game has only hidden information (all players have the same information), then you must implement {@link HiddenMaterialRules} instead.
+ */
 export declare abstract class SecretMaterialRules<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> extends HiddenMaterialRules<Player, MaterialType, LocationType> implements SecretInformation<MaterialGame, MaterialMove<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> {
+    /**
+     * Link {@link HiddenMaterialRules.hidingStrategies}, but with knowledge of whom the item should be hidden from.
+     * See {@link HidingSecretsStrategy}
+     */
     abstract hidingStrategies: Partial<Record<MaterialType, Partial<Record<LocationType, HidingSecretsStrategy<Player, LocationType>>>>>;
+    /**
+     * With the material approach, we can offer a default working implementation for {@link SecretInformation.getPlayerView}
+     */
     getPlayerView(player: Player): MaterialGame<Player, MaterialType, LocationType>;
+    /**
+     * With the material approach, we can offer a default working implementation for {@link SecretInformation.getPlayerMoveView}
+     */
     getPlayerMoveView(move: MaterialMoveRandomized<Player, MaterialType, LocationType>, player: Player): MaterialMove<Player, MaterialType, LocationType>;
 }
+/**
+ * A Hiding Strategy is a function that takes an item and a player and returns a list of path to hide in the item object.
+ * If the player parameter is undefined, the function must return the information to hide from the spectators.
+ * See {@link hideItemIdToOthers} and {@link hideFrontToOthers} for 2 HidingSecretsStrategy frequently used.
+ */
 export type HidingSecretsStrategy<P extends number = number, L extends number = number> = (item: MaterialItem<P, L>, player?: P) => string[];
+/**
+ * Hide the item id to all players except the player that is equal to item.location.player.
+ * Used to hide cards in a player's hand from others for instance.
+ * @param item The item to hide information from
+ * @param player The player to hide information to (or the spectator)
+ */
 export declare const hideItemIdToOthers: <P extends number = number, L extends number = number>(item: MaterialItem<P, L>, player?: P) => string[];
+/**
+ * Hide the item.id.front to all players except the player that is equal to item.location.player.
+ * @param item The item to hide information from
+ * @param player The player to hide information to (or the spectator)
+ */
 export declare const hideFrontToOthers: HidingStrategy;

package/dist/material/SecretMaterialRules.js

@@ -17,22 +17,44 @@ var __extends = (this && this.__extends) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hideFrontToOthers = exports.hideItemIdToOthers = exports.SecretMaterialRules = void 0;
 var HiddenMaterialRules_1 = require("./HiddenMaterialRules");
-var SecretMaterialRules = (function (_super) {
+/**
+ * Implement SecretMaterialRules when you want to use the {@link MaterialRules} approach with {@link SecretInformation}.
+ * Using some {@link HidingSecretsStrategy} allows to enforce the security of a game with secret information easily.
+ * If the game has only hidden information (all players have the same information), then you must implement {@link HiddenMaterialRules} instead.
+ */
+var SecretMaterialRules = /** @class */ (function (_super) {
     __extends(SecretMaterialRules, _super);
     function SecretMaterialRules() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * With the material approach, we can offer a default working implementation for {@link SecretInformation.getPlayerView}
+     */
     SecretMaterialRules.prototype.getPlayerView = function (player) {
         return this.getView(player);
     };
+    /**
+     * With the material approach, we can offer a default working implementation for {@link SecretInformation.getPlayerMoveView}
+     */
     SecretMaterialRules.prototype.getPlayerMoveView = function (move, player) {
         return this.getMoveView(move, player);
     };
     return SecretMaterialRules;
 }(HiddenMaterialRules_1.HiddenMaterialRules));
 exports.SecretMaterialRules = SecretMaterialRules;
+/**
+ * Hide the item id to all players except the player that is equal to item.location.player.
+ * Used to hide cards in a player's hand from others for instance.
+ * @param item The item to hide information from
+ * @param player The player to hide information to (or the spectator)
+ */
 var hideItemIdToOthers = function (item, player) { return item.location.player === player ? [] : ['id']; };
 exports.hideItemIdToOthers = hideItemIdToOthers;
+/**
+ * Hide the item.id.front to all players except the player that is equal to item.location.player.
+ * @param item The item to hide information from
+ * @param player The player to hide information to (or the spectator)
+ */
 var hideFrontToOthers = function (item, player) { return item.location.player === player ? [] : ['id.front']; };
 exports.hideFrontToOthers = hideFrontToOthers;
 //# sourceMappingURL=SecretMaterialRules.js.map

package/dist/material/SecretMaterialRules.js.map

@@ -1 +1 @@
-{"version":3,"file":"SecretMaterialRules.js","sourceRoot":"","sources":["../../src/material/SecretMaterialRules.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,6DAA2E;AAU3E;IACU,uCAAuD;IADjE;;IAuBA,CAAC;IAVC,2CAAa,GAAb,UAAc,MAAc;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7B,CAAC;IAKD,+CAAiB,GAAjB,UAAkB,IAAgE,EAAE,MAAc;QAChG,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACvC,CAAC;IACH,0BAAC;AAAD,CAAC,AAvBD,CACU,yCAAmB,GAsB5B;AAvBqB,kDAAmB;AAsClC,IAAM,kBAAkB,GAAG,UAChC,IAAwB,EAAE,MAAU,IACvB,OAAA,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAA7C,CAA6C,CAAA;AAF/C,QAAA,kBAAkB,sBAE6B;AAOrD,IAAM,iBAAiB,GAAmB,UAC/C,IAAwB,EAAE,MAAU,IACvB,OAAA,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAnD,CAAmD,CAAA;AAFrD,QAAA,iBAAiB,qBAEoC"}
+{"version":3,"file":"SecretMaterialRules.js","sourceRoot":"","sources":["../../src/material/SecretMaterialRules.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,6DAA2E;AAK3E;;;;GAIG;AACH;IACU,uCAAuD;IADjE;;IAuBA,CAAC;IAbC;;OAEG;IACH,2CAAa,GAAb,UAAc,MAAc;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,+CAAiB,GAAjB,UAAkB,IAAgE,EAAE,MAAc;QAChG,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACvC,CAAC;IACH,0BAAC;AAAD,CAAC,AAvBD,CACU,yCAAmB,GAsB5B;AAvBqB,kDAAmB;AAgCzC;;;;;GAKG;AACI,IAAM,kBAAkB,GAAG,UAChC,IAAwB,EAAE,MAAU,IACvB,OAAA,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAA7C,CAA6C,CAAA;AAF/C,QAAA,kBAAkB,sBAE6B;AAE5D;;;;GAIG;AACI,IAAM,iBAAiB,GAAmB,UAC/C,IAAwB,EAAE,MAAU,IACvB,OAAA,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAnD,CAAmD,CAAA;AAFrD,QAAA,iBAAiB,qBAEoC"}