cm-chess 3.5.3 → 3.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cm-chess",
-  "version": "3.5.3",
+  "version": "3.6.1",
   "description": "It's like chess.js, but in ES6 and can handle variations (tree-structured move history)",
   "main": "./src/Chess.js",
   "type": "module",

package/src/Chess.js

@@ -33,6 +33,18 @@ export const EVENT_TYPE = {
     initialized: "initialized"
 }
 
+export const GAME_VARIANT = {
+    standard: "standard",
+    chess960: "chess960"
+//  kingOfTheHill: "kingOfTheHill",
+//  threeCheck: "threeCheck",
+//  antichess: "antichess",
+//  atomic: "atomic",
+//  horde: "horde",
+//  racingKings: "racingKings",
+//  crazyhouse: "crazyhouse"
+}
+
 function publishEvent(observers, event) {
     for (const observer of observers) {
         setTimeout(() => {
@@ -52,6 +64,7 @@ export class Chess {
      * - an object with these properties:
      *      fen: a FEN string
      *      pgn: a PGN
+     *      gameVariant:
      *      chess960: true, if chess960 are used
      *      sloppy: true, if sloppy parsing is allowed
      */
@@ -60,10 +73,15 @@ export class Chess {
         this.props = {
             fen: undefined, // use a fen or a pgn with setUpFen
             pgn: undefined,
-            chess960: false,
+            gameVariant: GAME_VARIANT.standard,
+            chess960: undefined,
             sloppy: true, // sloppy parsing allows small mistakes in SAN
             ...props
         }
+        if(this.props.chess960 !== undefined) {
+            console.warn("props.chess960 is deprecated, use GAME_VARIANT")
+            this.props.gameVariant = GAME_VARIANT.chess960
+        }
         if (typeof props === "string") {
             console.warn("directly passing a FEN is deprecated, use `{fen: \"" + props + "\"}`")
             this.props.fen = props
@@ -117,7 +135,7 @@ export class Chess {
         if (move) {
             return move.gameOver
         } else {
-            return new ChessJs(this.fen(), {chess960: this.props.chess960}).game_over()
+            return new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960}).game_over()
         }
     }
 
@@ -129,7 +147,7 @@ export class Chess {
         if (move) {
             return move.inDraw === true
         } else {
-            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_draw()
+            return new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960}).in_draw()
         }
     }
 
@@ -141,7 +159,7 @@ export class Chess {
         if (move) {
             return move.inStalemate === true
         } else {
-            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_stalemate()
+            return new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960}).in_stalemate()
         }
     }
 
@@ -153,7 +171,7 @@ export class Chess {
         if (move) {
             return move.insufficientMaterial === true
         } else {
-            return new ChessJs(this.fen(), {chess960: this.props.chess960}).insufficient_material()
+            return new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960}).insufficient_material()
         }
     }
 
@@ -173,7 +191,7 @@ export class Chess {
         if (move) {
             return move.inCheckmate === true
         } else {
-            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_checkmate()
+            return new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960}).in_checkmate()
         }
     }
 
@@ -185,7 +203,7 @@ export class Chess {
         if (move) {
             return move.inCheck === true
         } else {
-            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_check()
+            return new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960}).in_check()
         }
     }
 
@@ -213,9 +231,9 @@ export class Chess {
      * @param fen
      */
     load(fen) {
-        const chess = new ChessJs(fen, {chess960: this.props.chess960})
+        const chess = new ChessJs(fen, {chess960: this.props.gameVariant === GAME_VARIANT.chess960})
         if (chess && chess.fen() === fen) {
-            this.pgn = new Pgn(undefined, {chess960: this.props.chess960})
+            this.pgn = new Pgn(undefined, {chess960: this.props.gameVariant === GAME_VARIANT.chess960})
             if (fen !== FEN.start) {
                 this.pgn.header.tags[TAGS.SetUp] = "1"
                 this.pgn.header.tags[TAGS.FEN] = chess.fen()
@@ -229,12 +247,15 @@ export class Chess {
 
     /**
      * Load a PGN with variations, NAGs, header and annotations. cm-chess uses cm-pgn
-     * fot the header and history. See https://github.com/shaack/cm-pgn
+     * for the header and history. See https://github.com/shaack/cm-pgn
      * @param pgn
      * @param sloppy to allow sloppy SAN
      */
     loadPgn(pgn, sloppy = this.props.sloppy) {
         this.pgn = new Pgn(pgn, {sloppy: sloppy})
+        if(this.pgn.props.chess960) {
+            this.props.gameVariant = GAME_VARIANT.chess960
+        }
         publishEvent(this.observers, {type: EVENT_TYPE.initialized, pgn: pgn})
     }
 
@@ -279,7 +300,7 @@ export class Chess {
      * @returns {{}}
      */
     moves(options = undefined, move = this.lastMove()) {
-        const chessJs = new ChessJs(this.fen(move), {chess960: this.props.chess960})
+        const chessJs = new ChessJs(this.fen(move), {chess960: this.props.gameVariant === GAME_VARIANT.chess960})
         return chessJs.moves(options)
     }
 
@@ -313,7 +334,7 @@ export class Chess {
      * @returns {[]} the pieces (positions) at a specific move
      */
     pieces(type = undefined, color = undefined, move = this.lastMove()) {
-        const chessJs = move ? new ChessJs(move.fen, {chess960: this.props.chess960}) : new ChessJs(this.fen(), {chess960: this.props.chess960})
+        const chessJs = move ? new ChessJs(move.fen, {chess960: this.props.gameVariant === GAME_VARIANT.chess960}) : new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960})
         let result = []
         for (let i = 0; i < 64; i++) {
             const square = SQUARES[i]
@@ -341,7 +362,7 @@ export class Chess {
      * @returns {{color: any, type: any}|null}
      */
     piece(square, move = this.lastMove()) {
-        const chessJs = move ? new ChessJs(move.fen, {chess960: this.props.chess960}) : new ChessJs(this.fen(), {chess960: this.props.chess960})
+        const chessJs = move ? new ChessJs(move.fen, {chess960: this.props.gameVariant === GAME_VARIANT.chess960}) : new ChessJs(this.fen(), {chess960: this.props.gameVariant === GAME_VARIANT.chess960})
         return chessJs.get(square)
     }
 

package/test/TestChess.js

@@ -8,7 +8,7 @@ import {Chess, COLOR, FEN} from "../src/Chess.js"
 describe("Chess", function () {
 
     it("should make a black move from FEN and SAN", function () {
-        const chess = new Chess("rnbqkbnr/pppp1ppp/8/4p3/4PP2/8/PPPP2PP/RNBQKBNR b KQkq f3 0 2")
+        const chess = new Chess({fen: "rnbqkbnr/pppp1ppp/8/4p3/4PP2/8/PPPP2PP/RNBQKBNR b KQkq f3 0 2"})
         const result = chess.move("d5")
         assert.true(result)
         const chess2 = new Chess({fen: "rnbqkbnr/ppp2ppp/8/3pp3/4PP2/8/PPPP2PP/RNBQKBNR w KQkq d6 0 3"})
@@ -25,7 +25,7 @@ describe("Chess", function () {
 
     it("should load a game from FEN", function () {
         const fen = "4k3/pppppppp/8/8/8/8/PPPPPPPP/4K3 w - - 0 1"
-        const chess = new Chess(fen)
+        const chess = new Chess({fen: fen})
         assert.equal(chess.pgn.header.tags[TAGS.FEN], fen)
         assert.equal(chess.fen(), fen)
         assert.equal(chess.piece("e1").type, "k")
@@ -201,7 +201,7 @@ Kc4 7. Qb4+ Kd5 8. Qc5#) 5. Bc5# 1-0`)
     it("should not load incorrect FEN", function () {
         const fen = "4k3/pppppppp/8/8/8/8/PPPPPP/4K3 w - - 0 1"
         try {
-            new Chess(fen)
+            new Chess({fen: fen})
             assert.true(false)
         } catch (e) {
             // OK
@@ -221,7 +221,7 @@ Kc4 7. Qb4+ Kd5 8. Qc5#) 5. Bc5# 1-0`)
         assert.equal(chess.history().length, 0)
         assert.equal(chess.turn(), COLOR.white)
         assert.equal(chess.fen(), fen)
-        const result = chess.move("e4");
+        const result = chess.move("e4")
         assert.equal(chess.fen(), fen)
         assert.true(result === null)
         assert.true(chess.move("Ke2") !== null)
@@ -266,26 +266,26 @@ Kc4 7. Qb4+ Kd5 8. Qc5#) 5. Bc5# 1-0`)
     })
 
     it("should detect a check in a game without moves", function () {
-        const chess = new Chess("4k3/1P6/8/b7/6r1/8/pp2PPPP/2R1KBNR w K - 0 1")
+        const chess = new Chess({fen: "4k3/1P6/8/b7/6r1/8/pp2PPPP/2R1KBNR w K - 0 1"})
         assert.true(chess.inCheck())
     })
 
     // see https://www.chessmail.de/forum/thread.html?key=GINGFqlNiAjf&sv=6
     it("should make a move with sloppy SAN", function () {
-        let chess = new Chess("r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44")
-        let result = chess.move("R8c7", undefined,false)
+        let chess = new Chess({fen: "r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44"})
+        let result = chess.move("R8c7", undefined, false)
         assert.true(result !== null)
-        chess = new Chess("r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44")
-        result = chess.move("Rc8c7", undefined,false)
+        chess = new Chess({fen: "r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44"})
+        result = chess.move("Rc8c7", undefined, false)
         assert.true(result == null)
-        chess = new Chess("r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44")
-        result = chess.move("Rc8-c7", undefined,false)
+        chess = new Chess({fen: "r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44"})
+        result = chess.move("Rc8-c7", undefined, false)
         assert.true(result == null)
-        chess = new Chess("r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44")
-        result = chess.move("Rc8-c7", undefined,true)
+        chess = new Chess({fen: "r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44"})
+        result = chess.move("Rc8-c7", undefined, true)
         assert.true(result != null)
-        chess = new Chess("r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44")
-        result = chess.move("Rc8c7", undefined,true)
+        chess = new Chess({fen: "r1R2r1k/1R6/1P2B2p/4pPp1/4N1P1/7P/5P2/2R3K1 w - - 1 44"})
+        result = chess.move("Rc8c7", undefined, true)
         assert.true(result != null)
     })
 

package/test/TestChess960.js

@@ -2,13 +2,13 @@
  * @author Stefan Haack (https://shaack.com)
  */
 import {describe, it, assert} from "teevi/src/teevi.js"
-import {Chess} from "../src/Chess.js"
+import {Chess, GAME_VARIANT} from "../src/Chess.js"
 
 describe("Testing Chess 960", function () {
 
     it("should load a chess960 game from a valid chess960 fen and do castling", function () {
         const fen = "nrkbrnbq/pppppppp/8/8/8/8/PPPPPPPP/NRKBRNBQ w KQkq - 0 1"
-        const chess = new Chess({chess960: true})
+        const chess = new Chess({gameVariant: GAME_VARIANT.chess960})
         chess.load(fen)
         assert.equal(chess.fen(), fen)
         assert.true(chess.move("f4"))
@@ -58,6 +58,7 @@ N3xd4 exd4 28. Bxd4 Nac5 29. Bxf6 Nxf6 30. c7 b3 31. axb3 Na6 32. Kb1 Nb4
 33. Qc4 Ne8 34. Rd8 Qxf5+ 35. Ka1 Nc2+ 36. Qxc2 1-0`
         const chess = new Chess()
         chess.loadPgn(pgn)
+        assert.equal(chess.props.gameVariant, GAME_VARIANT.chess960)
         assert.equal(chess.fen(), "2rRn2k/2P3pp/8/pN3q2/8/1P6/1PQ4P/K5R1 b - - 0 36")
     })
 })