chess4js 1.0.0-beta.8 → 1.0.0-beta.9

package/README.md

@@ -27,7 +27,7 @@ hundred milliseconds on modern machines.
 The library provides predefined instances for every square (A1, B1, ..., H8). You can import them directly:
 
 ```js
-import { A1, G4, D6 } from "chess4js";
+import {A1, G4, D6} from "chess4js";
 ```
 
 ## Piece
@@ -56,7 +56,7 @@ import {WP, BK, WQ, BN} from "chess4js"
 exist: `WHITE` and `BLACK`. You can import them directly:
 
 ```js
-import { WHITE, BLACK } from "chess4js" 
+import {WHITE, BLACK} from "chess4js" 
 ```
 
 ## Bitboard
@@ -118,7 +118,7 @@ A non directly instantiable class that represents a move made on the board.
 ### Example
 
 ```js
-import { moveOf } from "chess4js"
+import {moveOf} from "chess4js"
 
 const myMove = moveOf("e2e4");
 ```
@@ -129,9 +129,9 @@ Represents a specific board state. Instances of this class are immutable. Modify
 inconsistent behavior. Use factory methods to generate new positions.
 
 ```js
-import { startpos, positionOf } from "chess4js"
+import {startpos, positionOf} from "chess4js"
 
-const initialPosition = startpos(); 
+const initialPosition = startpos();
 const somePosition = positionOf("rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1");
 
 ```
@@ -177,6 +177,7 @@ const somePosition = positionOf("rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w K
 | `moveFromString`       | `move`: `String`, `notation`: `Notation` default `UCI` | `Position`  | Retrieves the new Position that results from executing the move specified in the given notation. Throws a MoveException if the move is not legal. If no notation is provided, UCI notation is assumed. |
 | `toString`             | None                                                   | `string`    | retrieves a nice string representation                                                                                                                                                                 |
 | `flipSide`             | None                                                   | `Position`  | Creates a new Position identical to the current one, but with the active side toggled.                                                                                                                 |
+| `transpositionId`      | None                                                   | `String`    | Generates a unique string identifier for the current position, suitable for use as a key in a transposition table.                                                                                     |
 
 ### Factories
 
@@ -247,6 +248,7 @@ For the `Node` class:
 | `endLineComment`    | `Nullable<string>`                | The end-of-line comment for the node, which follows a semicolon ; and goes until the end of the line.        |
 | `suffixAnnotations` | `Nullable<ReadonlyArray<number>>` | The list of suffix annotations (NAGs) for the node.                                                          |
 | `parent`            | `Nullable<Node>`                  | The parent node. It can only be null when it is the root node, which evidently cannot have a parent.         |
+| `id`                | `number`                          | An id for the node.                                                                                          |
 
 ### Methods
 
@@ -288,7 +290,7 @@ For the `Node` class
 ### Example
 
 ```js
-import { strictMatch } from "chess4js";
+import {strictMatch} from "chess4js";
 
 const myGame = strictMatch(() => "someId");
 myGame.setTag("white", "foo")
@@ -298,12 +300,12 @@ myGame.setTag("site", "foobared place")
 myGame.setTag("date", "1999.06.10")
 
 myGame.root.appendMove("e4")
-           .appendMove("e5")
-           .appendMove("Bc4")
-           .appendMove("Nc6")
-           .appendMove("Qh5")
-           .appendMove("Nf6")
-           .appendMove("Qxf7#")
+    .appendMove("e5")
+    .appendMove("Bc4")
+    .appendMove("Nc6")
+    .appendMove("Qh5")
+    .appendMove("Nf6")
+    .appendMove("Qxf7#")
 
 ```
 
@@ -321,7 +323,7 @@ A non-instantiable class that provides basic information about ECO classificatio
 ### Example
 
 ```javascript
-import { strictMatch } from "chess4js";
+import {strictMatch} from "chess4js";
 
 const myGame = strictMatch(() => "someId");
 myGame.setTag("white", "foo")
@@ -331,14 +333,14 @@ myGame.setTag("site", "foobared place")
 myGame.setTag("date", "1999.06.10")
 
 myGame.root.appendMove("e4")
-           .appendMove("c5")
-           .appendMove("Nf3")
-           .appendMove("e6")
-           .appendMove("d4")
-           .appendMove("cxd4")
-           .appendMove("Nxd4")
-           .appendMove("Qb6")
-           
+    .appendMove("c5")
+    .appendMove("Nf3")
+    .appendMove("e6")
+    .appendMove("d4")
+    .appendMove("cxd4")
+    .appendMove("Nxd4")
+    .appendMove("Qb6")
+
 const ecoInfo = myGame.ecoInfo.eco // "B40"
 ```
 
@@ -368,9 +370,9 @@ Represents a score in a tournament. It can't be directly instantiated, you need
 #### Example
 
 ```javascript
-import { scoreOf } from "chess4js";
+import {scoreOf} from "chess4js";
 
-const hightScore = scoreOf("2.5"); 
+const hightScore = scoreOf("2.5");
 const lowScore = scoreOf("0.0");
 
 hightScore.compareTo(lowScore) // 1
@@ -404,7 +406,7 @@ factory.
 #### Example
 
 ```javascript
-import { playerOf } from "chess4js";
+import {playerOf} from "chess4js";
 
 const foo = playerOf("foo", 1600);
 const bar = playerOf("bar", 1600);
@@ -432,7 +434,7 @@ factory.
 #### Example
 
 ```javascript
-import { matchOf, playerOf } from "chess4js";
+import {matchOf, playerOf} from "chess4js";
 
 const white = playerOf("foo", 1600);
 const black = playerOf("bar", 1600);
@@ -482,74 +484,74 @@ behavior of a Swiss tournament, having a fixed number of rounds, for example. Ad
 before the next one can be generated.
 
 ```javascript
-import { tournament, playerOf } from "./chess4js.mjs";
+import {tournament, playerOf} from "./chess4js.mjs";
 
 const myTournament = tournament("swiss");
 
 function randomInt(min, max) {
-  return Math.floor(Math.random() * (max - min) + min);
+    return Math.floor(Math.random() * (max - min) + min);
 }
 
 function runMatch(match) {
-  const ratio = (match.white.currentElo - match.black.currentElo) / 100;
-  const random = Math.random();
-  if (match.white.currentElo >= match.black.currentElo) {
-    if (random < ratio) {
-      match.outcome = "1-0";
-    } else if (random == ratio) {
-      match.outcome = "1/2-1/2";
-    } else {
-      match.outcome = "0-1";
-    }
-  } else {
-    if (random < ratio) {
-      match.outcome = "0-1";
-    } else if (random == ratio) {
-      match.outcome = "1/2-1/2";
+    const ratio = (match.white.currentElo - match.black.currentElo) / 100;
+    const random = Math.random();
+    if (match.white.currentElo >= match.black.currentElo) {
+        if (random < ratio) {
+            match.outcome = "1-0";
+        } else if (random == ratio) {
+            match.outcome = "1/2-1/2";
+        } else {
+            match.outcome = "0-1";
+        }
     } else {
-      match.outcome = "1-0";
+        if (random < ratio) {
+            match.outcome = "0-1";
+        } else if (random == ratio) {
+            match.outcome = "1/2-1/2";
+        } else {
+            match.outcome = "1-0";
+        }
     }
-  }
 }
 
 const minElo = 1800;
 const maxElo = 2200;
 
 const players = [
-  "William Smith",
-  "Jack Jones",
-  "Oliver Williams",
-  "Joshua Brown",
-  "Thomas Wilson",
-  "Lachlan Taylor",
-  "Cooper Johnson",
-  "Noah White",
-  "Ethan Martin",
-  "Lucas Anderson",
-  "James Thompson",
-  "Samuel Nguyen",
-  "Jacob Thomas",
-  "Liam Walker",
-  "Alexander Harris",
-  "Benjamin Lee",
+    "William Smith",
+    "Jack Jones",
+    "Oliver Williams",
+    "Joshua Brown",
+    "Thomas Wilson",
+    "Lachlan Taylor",
+    "Cooper Johnson",
+    "Noah White",
+    "Ethan Martin",
+    "Lucas Anderson",
+    "James Thompson",
+    "Samuel Nguyen",
+    "Jacob Thomas",
+    "Liam Walker",
+    "Alexander Harris",
+    "Benjamin Lee",
 ].map((name) => {
-  return playerOf(name, randomInt(minElo, maxElo));
+    return playerOf(name, randomInt(minElo, maxElo));
 });
 
 players.forEach((player) => {
-  console.log(`adding player ${player.toString()}`);
-  myTournament.addPlayer(player);
+    console.log(`adding player ${player.toString()}`);
+    myTournament.addPlayer(player);
 });
 
 while (!myTournament.completed) {
-  console.log("next round");
-  myTournament.nextRound().forEach((match) => {
-    runMatch(match);
-    console.log(`${match.toString()}`);
-  });
+    console.log("next round");
+    myTournament.nextRound().forEach((match) => {
+        runMatch(match);
+        console.log(`${match.toString()}`);
+    });
 }
 
-console.log(myTournament.leaderboard.map( e => e.toString() + ` - ${e.score.toString()}`));
+console.log(myTournament.leaderboard.map(e => e.toString() + ` - ${e.score.toString()}`));
 ```
 
 *Creating an arena tournament*
@@ -561,83 +563,83 @@ is only intended to show the class's behavior when used in arena mode; it is not
 management of an arena tournament, which is typically more complex.
 
 ```javascript
-import { tournament, playerOf } from "./chess4js.mjs";
+import {tournament, playerOf} from "./chess4js.mjs";
 
 const myTournament = tournament("arena");
 
 function randomInt(min, max) {
-  return Math.floor(Math.random() * (max - min) + min);
+    return Math.floor(Math.random() * (max - min) + min);
 }
 
 function runMatch(match) {
-  const ratio = (match.white.currentElo - match.black.currentElo) / 100;
-  const random = Math.random();
-  if (match.white.currentElo >= match.black.currentElo) {
-    if (random < ratio) {
-      match.outcome = "1-0";
-    } else if (random == ratio) {
-      match.outcome = "1/2-1/2";
-    } else {
-      match.outcome = "0-1";
-    }
-  } else {
-    if (random < ratio) {
-      match.outcome = "0-1";
-    } else if (random == ratio) {
-      match.outcome = "1/2-1/2";
+    const ratio = (match.white.currentElo - match.black.currentElo) / 100;
+    const random = Math.random();
+    if (match.white.currentElo >= match.black.currentElo) {
+        if (random < ratio) {
+            match.outcome = "1-0";
+        } else if (random == ratio) {
+            match.outcome = "1/2-1/2";
+        } else {
+            match.outcome = "0-1";
+        }
     } else {
-      match.outcome = "1-0";
+        if (random < ratio) {
+            match.outcome = "0-1";
+        } else if (random == ratio) {
+            match.outcome = "1/2-1/2";
+        } else {
+            match.outcome = "1-0";
+        }
     }
-  }
 }
 
 const minElo = 1800;
 const maxElo = 2200;
 
 const players = [
-  "William Smith",
-  "Jack Jones",
-  "Oliver Williams",
-  "Joshua Brown",
-  "Thomas Wilson",
-  "Lachlan Taylor",
-  "Cooper Johnson",
-  "Noah White",
-  "Ethan Martin",
-  "Lucas Anderson",
-  "James Thompson",
-  "Samuel Nguyen",
-  "Jacob Thomas",
-  "Liam Walker",
-  "Alexander Harris",
-  "Benjamin Lee",
+    "William Smith",
+    "Jack Jones",
+    "Oliver Williams",
+    "Joshua Brown",
+    "Thomas Wilson",
+    "Lachlan Taylor",
+    "Cooper Johnson",
+    "Noah White",
+    "Ethan Martin",
+    "Lucas Anderson",
+    "James Thompson",
+    "Samuel Nguyen",
+    "Jacob Thomas",
+    "Liam Walker",
+    "Alexander Harris",
+    "Benjamin Lee",
 ].map((name) => {
-  return playerOf(name, randomInt(minElo, maxElo));
+    return playerOf(name, randomInt(minElo, maxElo));
 });
 
 players.forEach((player) => {
-  console.log(`adding player ${player.toString()}`);
-  myTournament.addPlayer(player);
+    console.log(`adding player ${player.toString()}`);
+    myTournament.addPlayer(player);
 });
 
 const gamesLimit = 100;
 
 let gamesQueue = [];
 
-while((myTournament.finishedMatches.length + myTournament.activeMatches.length) < gamesLimit) {
+while ((myTournament.finishedMatches.length + myTournament.activeMatches.length) < gamesLimit) {
     myTournament.nextRound();
-    myTournament.activeMatches.forEach( (match) => gamesQueue.push(match) )
+    myTournament.activeMatches.forEach((match) => gamesQueue.push(match))
     if (gamesQueue.length > 0) {
-        for(let i = 0; i < (gamesQueue.length / 4 * 3); i++) {
+        for (let i = 0; i < (gamesQueue.length / 4 * 3); i++) {
             runMatch(gamesQueue.pop());
         }
     }
     gamesQueue = [];
 }
 
-myTournament.activeMatches.forEach( (match) => runMatch(match) );
+myTournament.activeMatches.forEach((match) => runMatch(match));
 
 myTournament.completed = true;
 
-console.log(myTournament.leaderboard.map( e => e.toString() + ` - ${e.score.toString()}`));
+console.log(myTournament.leaderboard.map(e => e.toString() + ` - ${e.score.toString()}`));
 ```

package/chess4js.d.mts

@@ -72,7 +72,7 @@ export declare class Game {
     toAnalysis(idSupplier?: () => Nullable<any>): Game;
     deleteFromExclusive(node: Node): Node;
     deleteFromInclusive(node: Node): Node;
-    deleteBefore(_this_: Game, node: Node): Node;
+    deleteBefore(node: Node): Node;
     updateEco(): void;
 }
 /** @deprecated $metadata$ is used for internal purposes, please don't use it in your code, because it can be removed at any moment */
@@ -107,6 +107,7 @@ export declare namespace Move.$metadata$ {
 }
 export declare class Node {
     private constructor();
+    get id(): number;
     get position(): Position;
     get move(): Nullable<Move>;
     get children(): ReadonlyArray<Node>;
@@ -244,6 +245,7 @@ export declare class Position {
     move(move: Move): Position;
     moveFromString(move: string, notation?: Notation): Position;
     flipSide(): Position;
+    transpositionId(): string;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;
     toString(): string;