@mshowes/brackets-manager 1.8.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Corentin Girard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# brackets-manager.js
+
+[![npm](https://img.shields.io/npm/v/brackets-manager.svg)](https://www.npmjs.com/package/brackets-manager)
+[![Downloads](https://img.shields.io/npm/dt/brackets-manager.svg)](https://www.npmjs.com/package/brackets-manager)
+[![Package Quality](https://packagequality.com/shield/brackets-manager.svg)](https://packagequality.com/#?package=brackets-manager)
+
+A simple library to manage tournament brackets (round-robin, single elimination, double elimination).
+
+It contains all the logic needed to manage tournaments.
+
+# Features
+
+- [BYE](https://en.wikipedia.org/wiki/Bye_%28sports%29) supported: only during creation (for seeding and balancing).
+- Forfeit supported: only during updates.
+- Match supported (locked, waiting, ready, running, completed, archived).
+- Multiple stages per tournament.
+  - So you can first have a round-robin stage (which will give you a seeding), then an elimination stage.
+
+# Interface
+
+- This library doesn't come with a GUI to create and update tournaments.
+- You can use [brackets-viewer.js](https://github.com/Drarig29/brackets-viewer.js) to display the current state of a stage.
+- It is designed to be used with any type of storage (JSON, in-memory, SQL, Redis, and more).
+- Some storage implementations are already available (see the [documentation](https://drarig29.github.io/brackets-docs/user-guide/storage/)).
+
+# Getting Started
+
+For more information, see the [documentation](https://drarig29.github.io/brackets-docs/getting-started/).
+
+```js
+const { JsonDatabase } = require('brackets-json-db');
+const { BracketsManager } = require('brackets-manager');
+
+const storage = new JsonDatabase();
+const manager = new BracketsManager(storage);
+
+// Create an elimination stage for tournament `3`.
+await manager.create.stage({
+  tournamentId: 3,
+  name: 'Elimination stage',
+  type: 'double_elimination',
+  seeding: ['Team 1', 'Team 2', 'Team 3', 'Team 4'],
+  settings: { grandFinal: 'double' },
+});
+
+await manager.update.match({
+  id: 0, // First match of winner bracket (round 1)
+  opponent1: { score: 16, result: 'win' },
+  opponent2: { score: 12 },
+});
+```
+
+Rendered with the [viewer](https://github.com/Drarig29/brackets-viewer.js):
+
+<img width="581" alt="image" src="https://user-images.githubusercontent.com/9317502/232905749-195c4f40-527c-4f17-a639-82f639432ed9.png">
+
+As you can see, the [manager](https://drarig29.github.io/brackets-docs/reference/manager/classes/BracketsManager.html) is composed of submodules, which themselves have methods:
+  - [`create`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Create.html) module: [`manager.create.stage()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Create.html#stage)
+  - [`get`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Get.html) module: [`manager.get.seeding()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Get.html#seeding), [`manager.get.finalStandings()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Get.html#finalStandings), ...
+  - [`update`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Update.html) module: [`manager.update.match()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Update.html#match), [`manager.update.confirmSeeding()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Update.html#confirmSeeding), ...
+  - [`reset`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Reset.html) module: [`manager.reset.seeding()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Reset.html#seeding), [`manager.reset.matchGame()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Reset.html#matchResults), ...
+  - [`delete`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Delete.html) module: [`manager.delete.stage()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Delete.html#stage)
+  - [`find`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Find.html) module: [`manager.find.match()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Find.html#match), [`manager.find.nextMatches()`](https://drarig29.github.io/brackets-docs/reference/manager/classes/_internal_.Find.html#nextMatches), ...
+  - [`storage`](https://drarig29.github.io/brackets-docs/reference/manager/interfaces/Storage.html) module: this gives you access to the abstract storage interface. Use it as a last resort.
+
+You can navigate the API documentation here: [`BracketsManager` class documentation](https://drarig29.github.io/brackets-docs/reference/manager/classes/BracketsManager.html)
+
+All the helpers defined by the library are available [here](https://drarig29.github.io/brackets-docs/reference/manager/modules/helpers.html):
+
+```js
+const { helpers } = require('brackets-manager');
+```
+
+# Credits
+
+This library has been created to be used by the [Nantarena](https://nantarena.net/).
+
+It has been inspired by:
+
+- [Toornament](https://www.toornament.com/en_US/) (configuration, API and data format)
+- [Challonge's bracket generator](https://challonge.com/tournaments/bracket_generator)
+- [jQuery Bracket](http://www.aropupu.fi/bracket/) (feature examples)

package/dist/base/getter.d.ts

@@ -0,0 +1,272 @@
+import { DeepPartial, Storage } from '../types';
+import { Group, Match, MatchGame, Round, SeedOrdering, Stage, StageType, GroupType, Id } from 'brackets-model';
+import { RoundPositionalInfo } from '../types';
+import { StageCreator } from './stage/creator';
+export declare class BaseGetter {
+    protected readonly storage: Storage;
+    /**
+     * Creates an instance of a Storage getter.
+     *
+     * @param storage The implementation of Storage.
+     */
+    constructor(storage: Storage);
+    /**
+     * Gets all the rounds that contain ordered participants.
+     *
+     * @param stage The stage to get rounds from.
+     */
+    protected getOrderedRounds(stage: Stage): Promise<Round[]>;
+    /**
+     * Gets all the rounds that contain ordered participants in a single elimination stage.
+     *
+     * @param stageId ID of the stage.
+     */
+    private getOrderedRoundsSingleElimination;
+    /**
+     * Gets all the rounds that contain ordered participants in a double elimination stage.
+     *
+     * @param stageId ID of the stage.
+     */
+    private getOrderedRoundsDoubleElimination;
+    /**
+     * Gets the positional information (number in group and total number of rounds in group) of a round based on its id.
+     *
+     * @param roundId ID of the round.
+     */
+    protected getRoundPositionalInfo(roundId: Id): Promise<RoundPositionalInfo>;
+    /**
+     * Gets the matches leading to the given match.
+     *
+     * @param match The current match.
+     * @param matchLocation Location of the current match.
+     * @param stage The parent stage.
+     * @param roundNumber Number of the round.
+     */
+    protected getPreviousMatches(match: Match, matchLocation: GroupType, stage: Stage, roundNumber: number): Promise<Match[]>;
+    /**
+     * Gets the matches leading to the given match, which is in a final group (consolation final or grand final).
+     *
+     * @param match The current match.
+     * @param stage The parent stage.
+     * @param roundNumber Number of the current round.
+     */
+    private getPreviousMatchesFinal;
+    /**
+     * Gets the matches leading to the given match, which is in a final group (consolation final).
+     *
+     * @param match The current match.
+     * @param stage The parent stage.
+     */
+    private getPreviousMatchesFinalSingleElimination;
+    /**
+     * Gets the matches leading to the given match, which is in a final group (grand final).
+     *
+     * @param match The current match.
+     * @param roundNumber Number of the current round.
+     */
+    private getPreviousMatchesFinalDoubleElimination;
+    /**
+     * Gets the matches leading to a given match from the loser bracket.
+     *
+     * @param match The current match.
+     * @param stage The parent stage.
+     * @param roundNumber Number of the round.
+     */
+    private getPreviousMatchesLB;
+    /**
+     * Gets the matches leading to a given match in a major round (every round of upper bracket or specific ones in lower bracket).
+     *
+     * @param match The current match.
+     * @param roundNumber Number of the round.
+     */
+    private getMatchesBeforeMajorRound;
+    /**
+     * Gets the matches leading to a given match in the first round of the loser bracket.
+     *
+     * @param match The current match.
+     * @param winnerBracketId ID of the winner bracket.
+     * @param roundNumberWB The number of the previous round in the winner bracket.
+     */
+    private getMatchesBeforeFirstRoundLB;
+    /**
+     * Gets the matches leading to a given match in a minor round of the loser bracket.
+     *
+     * @param match The current match.
+     * @param winnerBracketId ID of the winner bracket.
+     * @param roundNumber Number of the current round.
+     * @param roundNumberWB The number of the previous round in the winner bracket.
+     */
+    private getMatchesBeforeMinorRoundLB;
+    /**
+     * Gets the match(es) where the opponents of the current match will go just after.
+     *
+     * @param match The current match.
+     * @param matchLocation Location of the current match.
+     * @param stage The parent stage.
+     * @param roundNumber The number of the current round.
+     * @param roundCount Count of rounds.
+     */
+    protected getNextMatches(match: Match, matchLocation: GroupType, stage: Stage, roundNumber: number, roundCount: number): Promise<(Match | null)[]>;
+    /**
+     * Gets the match(es) where the opponents of the current match of winner bracket will go just after.
+     *
+     * @param match The current match.
+     * @param stage The parent stage.
+     * @param roundNumber The number of the current round.
+     * @param roundCount Count of rounds.
+     */
+    private getNextMatchesWB;
+    /**
+     * Gets the match(es) where the opponents of the current match of an upper bracket will go just after.
+     *
+     * @param match The current match.
+     * @param stage The parent stage.
+     * @param roundNumber The number of the current round.
+     * @param roundCount Count of rounds.
+     */
+    private getNextMatchesUpperBracket;
+    /**
+     * Gets the match(es) where the opponents of the current match of the unique bracket of a single elimination will go just after.
+     *
+     * @param match The current match.
+     * @param stageType Type of the stage.
+     * @param roundNumber The number of the current round.
+     * @param roundCount Count of rounds.
+     */
+    private getNextMatchesUpperBracketSingleElimination;
+    /**
+     * Gets the match(es) where the opponents of the current match of the unique bracket of a double elimination will go just after.
+     *
+     * @param match The current match.
+     * @param stageType Type of the stage.
+     * @param roundNumber The number of the current round.
+     * @param roundCount Count of rounds.
+     */
+    private getNextMatchesUpperBracketDoubleElimination;
+    /**
+     * Gets the match(es) where the opponents of the current match of loser bracket will go just after.
+     *
+     * @param match The current match.
+     * @param stage The parent stage.
+     * @param roundNumber The number of the current round.
+     * @param roundCount Count of rounds.
+     */
+    private getNextMatchesLB;
+    /**
+     * Gets the first match of the final group (consolation final or grand final).
+     *
+     * @param finalGroupId ID of the final group.
+     */
+    private getFinalGroupFirstMatch;
+    /**
+     * Gets the consolation final in a double elimination tournament.
+     *
+     * @param finalGroupId ID of the final group.
+     */
+    private getConsolationFinalMatchDoubleElimination;
+    /**
+     * Gets the match following the current match, which is in the final group (consolation final or grand final).
+     *
+     * @param match The current match.
+     * @param stage The parent stage.
+     * @param roundNumber The number of the current round.
+     * @param roundCount The count of rounds.
+     */
+    private getNextMatchesFinal;
+    /**
+     * Gets the match where the opponents of the current match of a winner bracket's major round will go just after.
+     *
+     * @param match The current match.
+     * @param roundNumber The number of the current round.
+     */
+    private getMatchAfterMajorRoundLB;
+    /**
+     * Gets the match where the opponents of the current match of a winner bracket's minor round will go just after.
+     *
+     * @param match The current match.
+     * @param roundNumber The number of the current round.
+     */
+    private getMatchAfterMinorRoundLB;
+    /**
+     * Returns the good seeding ordering based on the stage's type.
+     *
+     * @param stageType The type of the stage.
+     * @param create A reference to a Create instance.
+     */
+    protected static getSeedingOrdering(stageType: StageType, create: StageCreator): SeedOrdering;
+    /**
+     * Returns the matches which contain the seeding of a stage based on its type.
+     *
+     * @param stageId ID of the stage.
+     * @param stageType The type of the stage.
+     */
+    protected getSeedingMatches(stageId: Id, stageType: StageType): Promise<Match[] | null>;
+    /**
+     * Gets the first round of the upper bracket.
+     *
+     * @param stageId ID of the stage.
+     */
+    private getUpperBracketFirstRound;
+    /**
+     * Gets the last round of a group.
+     *
+     * @param groupId ID of the group.
+     */
+    private getLastRound;
+    /**
+     * Returns the id of the final group (containing consolation final, or grand final, or both).
+     *
+     * @param stageId ID of the stage.
+     * @param stageType Type of the stage.
+     */
+    private getFinalGroupId;
+    /**
+     * Gets the upper bracket (the only bracket if single elimination or the winner bracket in double elimination).
+     *
+     * @param stageId ID of the stage.
+     */
+    protected getUpperBracket(stageId: Id): Promise<Group>;
+    /**
+     * Gets the loser bracket.
+     *
+     * @param stageId ID of the stage.
+     */
+    protected getLoserBracket(stageId: Id): Promise<Group | null>;
+    /**
+     * Gets the corresponding match in the next round ("diagonal match") the usual way.
+     *
+     * Just like from Round 1 to Round 2 in a single elimination stage.
+     *
+     * @param groupId ID of the group.
+     * @param roundNumber Number of the round in its parent group.
+     * @param matchNumber Number of the match in its parent round.
+     */
+    private getDiagonalMatch;
+    /**
+     * Gets the corresponding match in the next round ("parallel match") the "major round to minor round" way.
+     *
+     * Just like from Round 1 to Round 2 in the loser bracket of a double elimination stage.
+     *
+     * @param groupId ID of the group.
+     * @param roundNumber Number of the round in its parent group.
+     * @param matchNumber Number of the match in its parent round.
+     */
+    private getParallelMatch;
+    /**
+     * Finds a match in a given group. The match must have the given number in a round of which the number in group is given.
+     *
+     * **Example:** In group of id 1, give me the 4th match in the 3rd round.
+     *
+     * @param groupId ID of the group.
+     * @param roundNumber Number of the round in its parent group.
+     * @param matchNumber Number of the match in its parent round.
+     */
+    protected findMatch(groupId: Id, roundNumber: number, matchNumber: number): Promise<Match>;
+    /**
+     * Finds a match game based on its `id` or based on the combination of its `parent_id` and `number`.
+     *
+     * @param game Values to change in a match game.
+     */
+    protected findMatchGame(game: DeepPartial<MatchGame>): Promise<MatchGame>;
+}
+//# sourceMappingURL=getter.d.ts.map

package/dist/base/getter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getter.d.ts","sourceRoot":"","sources":["../../src/base/getter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAC/G,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAG/C,qBAAa,UAAU;IAEnB,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAEpC;;;;OAIG;gBACS,OAAO,EAAE,OAAO;IAI5B;;;;OAIG;cACa,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAShE;;;;OAIG;YACW,iCAAiC;IAI/C;;;;OAIG;YACW,iCAAiC;IAgB/C;;;;OAIG;cACa,sBAAsB,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAajF;;;;;;;OAOG;cACa,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAa/H;;;;;;OAMG;YACW,uBAAuB;IAOrC;;;;;OAKG;YACW,wCAAwC;IAuBtD;;;;;OAKG;YACW,wCAAwC;IA+BtD;;;;;;OAMG;YACW,oBAAoB;IAqBlC;;;;;OAKG;YACW,0BAA0B;IAOxC;;;;;;OAMG;YACW,4BAA4B;IAO1C;;;;;;;OAOG;YACW,4BAA4B;IAS1C;;;;;;;;OAQG;cACa,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC;IAexJ;;;;;;;OAOG;YACW,gBAAgB;IAkB9B;;;;;;;OAOG;YACW,0BAA0B;IAOxC;;;;;;;OAOG;YACW,2CAA2C;IAgBzD;;;;;;;OAOG;YACW,2CAA2C;IASzD;;;;;;;OAOG;YACW,gBAAgB;IA2B9B;;;;OAIG;YACW,uBAAuB;IAOrC;;;;OAIG;YACW,yCAAyC;IAUvD;;;;;;;OAOG;YACW,mBAAmB;IAUjC;;;;;OAKG;YACW,yBAAyB;IAIvC;;;;;OAKG;YACW,yBAAyB;IAIvC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,GAAG,YAAY;IAI7F;;;;;OAKG;cACa,iBAAiB,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC;IAY7F;;;;OAIG;YACW,yBAAyB;IAOvC;;;;OAIG;YACW,YAAY;IAM1B;;;;;OAKG;YACW,eAAe;IAO7B;;;;OAIG;cACa,eAAe,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;IAM5D;;;;OAIG;cACa,eAAe,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAInE;;;;;;;;OAQG;YACW,gBAAgB;IAI9B;;;;;;;;OAQG;YACW,gBAAgB;IAI9B;;;;;;;;OAQG;cACa,SAAS,CAAC,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAkBhG;;;;OAIG;cACa,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAmBlF"}