cm-chess 3.5.1 → 3.5.2

package/LICENSE

@@ -1,7 +1,5 @@
 MIT License
 
-Copyright (c) 2020 Stefan Haack
-
 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

package/README.md

@@ -13,7 +13,7 @@ PGN header values, Nags and Comments.
 - It has a similar API to chess.js
 - It can handle history variations
 - It can add Nags, Comments and Annotations
-- It is used by the 7,000 users of [chessmail](https://www.chessmail.de) (it works)
+- It is a core component of my online chess server [chessmail.de](https://www.chessmail.de) (it works)
 
 ## API
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cm-chess",
-  "version": "3.5.1",
+  "version": "3.5.2",
   "description": "It's like chess.js, but in ES6 and can handle variations (tree-structured move history)",
   "main": "./src/Chess.js",
   "type": "module",
@@ -24,8 +24,8 @@
   },
   "homepage": "https://github.com/shaack/cm-chess#readme",
   "dependencies": {
-    "chess.mjs": "^1.4.0",
-    "cm-pgn": "3.3.2"
+    "chess.mjs": "^2.2.3",
+    "cm-pgn": "4.0.6"
   },
   "devDependencies": {
     "teevi": "^2.2.4"

package/src/Chess.js

@@ -47,17 +47,29 @@ function publishEvent(observers, event) {
  */
 export class Chess {
 
-    constructor(fenOrProps = FEN.start) {
+    /**
+     * @param props {object}
+     * - an object with these properties:
+     *      fen: a FEN string
+     *      pgn: a PGN
+     *      chess960: true, if chess960 are used
+     *      sloppy: true, if sloppy parsing is allowed
+     */
+    constructor(props = {}) {
         this.observers = []
         this.props = {
             fen: undefined, // use a fen or a pgn with setUpFen
             pgn: undefined,
-            sloppy: true // sloppy parsing allows small mistakes in SAN
+            chess960: false,
+            sloppy: true, // sloppy parsing allows small mistakes in SAN
+            ...props
+        }
+        if (typeof props === "string") {
+            console.warn("directly passing a FEN is deprecated, use `{fen: \"" + props + "\"}`")
+            this.props.fen = props
         }
-        if (typeof fenOrProps === "string") {
-            this.props.fen = fenOrProps
-        } else if (typeof fenOrProps === "object") {
-            Object.assign(this.props, fenOrProps)
+        if (!this.props.fen && !this.props.pgn) {
+            this.props.fen = FEN.start
         }
         if (this.props.fen) {
             this.load(this.props.fen)
@@ -105,7 +117,7 @@ export class Chess {
         if (move) {
             return move.gameOver
         } else {
-            return new ChessJs(this.fen()).game_over()
+            return new ChessJs(this.fen(), {chess960: this.props.chess960}).game_over()
         }
     }
 
@@ -117,7 +129,7 @@ export class Chess {
         if (move) {
             return move.inDraw === true
         } else {
-            return new ChessJs(this.fen()).in_draw()
+            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_draw()
         }
     }
 
@@ -129,7 +141,7 @@ export class Chess {
         if (move) {
             return move.inStalemate === true
         } else {
-            return new ChessJs(this.fen()).in_stalemate()
+            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_stalemate()
         }
     }
 
@@ -141,7 +153,7 @@ export class Chess {
         if (move) {
             return move.insufficientMaterial === true
         } else {
-            return new ChessJs(this.fen()).insufficient_material()
+            return new ChessJs(this.fen(), {chess960: this.props.chess960}).insufficient_material()
         }
     }
 
@@ -161,7 +173,7 @@ export class Chess {
         if (move) {
             return move.inCheckmate === true
         } else {
-            return new ChessJs(this.fen()).in_checkmate()
+            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_checkmate()
         }
     }
 
@@ -173,7 +185,7 @@ export class Chess {
         if (move) {
             return move.inCheck === true
         } else {
-            return new ChessJs(this.fen()).in_check()
+            return new ChessJs(this.fen(), {chess960: this.props.chess960}).in_check()
         }
     }
 
@@ -201,13 +213,13 @@ export class Chess {
      * @param fen
      */
     load(fen) {
-        const chess = new ChessJs(fen)
+        const chess = new ChessJs(fen, {chess960: this.props.chess960})
         if (chess && chess.fen() === fen) {
-            this.pgn = new Pgn()
+            this.pgn = new Pgn(undefined, {chess960: this.props.chess960})
             if (fen !== FEN.start) {
                 this.pgn.header.tags[TAGS.SetUp] = "1"
                 this.pgn.header.tags[TAGS.FEN] = chess.fen()
-                this.pgn.history.setUpFen = fen
+                this.pgn.history.props.setUpFen = fen
             }
         } else {
             throw Error("Invalid fen " + fen)
@@ -267,7 +279,7 @@ export class Chess {
      * @returns {{}}
      */
     moves(options = undefined, move = this.lastMove()) {
-        const chessJs = new ChessJs(this.fen(move))
+        const chessJs = new ChessJs(this.fen(move), {chess960: this.props.chess960})
         return chessJs.moves(options)
     }
 
@@ -301,7 +313,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) : new ChessJs(this.fen())
+        const chessJs = move ? new ChessJs(move.fen, {chess960: this.props.chess960}) : new ChessJs(this.fen(), {chess960: this.props.chess960})
         let result = []
         for (let i = 0; i < 64; i++) {
             const square = SQUARES[i]
@@ -329,7 +341,7 @@ export class Chess {
      * @returns {{color: any, type: any}|null}
      */
     piece(square, move = this.lastMove()) {
-        const chessJs = move ? new ChessJs(move.fen) : new ChessJs(this.fen())
+        const chessJs = move ? new ChessJs(move.fen, {chess960: this.props.chess960}) : new ChessJs(this.fen(), {chess960: this.props.chess960})
         return chessJs.get(square)
     }
 

package/test/TestChess.js

@@ -7,6 +7,15 @@ 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 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"})
+        const result2 = chess2.move("Ne2")
+        assert.true(result)
+    })
+
     it("should create empty Chess", () => {
         const chess = new Chess()
         assert.equal(chess.history().length, 0)
@@ -31,6 +40,7 @@ describe("Chess", function () {
         const chess = new Chess({pgn: pgn})
         assert.equal(chess.move("Nc6"), null)
         const result = chess.move("h6")
+        console.log("TestChess result", result)
         assert.equal(result.fen, "4k3/pppp1pp1/7p/4p3/4P3/P7/1PPP1PPP/4K3 w - - 0 3")
     })
 
@@ -205,10 +215,15 @@ Kc4 7. Qb4+ Kd5 8. Qc5#) 5. Bc5# 1-0`)
         }
     })
 
-    it("should load different PGNs and then work correctly", function () {
+    it("should load an unusual FEN", function () {
         const fen = "ppppkppp/pppppppp/pppppppp/pppppppp/8/8/8/RNBQKBNR w KQ - 0 1"
         const chess = new Chess({fen: fen})
-        assert.true(chess.move("e4") === null)
+        assert.equal(chess.history().length, 0)
+        assert.equal(chess.turn(), COLOR.white)
+        assert.equal(chess.fen(), fen)
+        const result = chess.move("e4");
+        assert.equal(chess.fen(), fen)
+        assert.true(result === null)
         assert.true(chess.move("Ke2") !== null)
         chess.load(FEN.start)
         assert.true(chess.move("e4"))

package/test/TestChess960.js

@@ -0,0 +1,63 @@
+/**
+ * @author Stefan Haack (https://shaack.com)
+ */
+import {describe, it, assert} from "teevi/src/teevi.js"
+import {Chess} 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})
+        chess.load(fen)
+        assert.equal(chess.fen(), fen)
+        assert.true(chess.move("f4"))
+        assert.true(chess.move("Nb6"))
+        assert.true(chess.move("Nb3"))
+        assert.true(chess.move("f6"))
+        assert.true(chess.move("e4"))
+        assert.true(chess.move("e5"))
+        assert.true(chess.move("f5"))
+        assert.true(chess.move("d5"))
+        assert.true(chess.move("g4"))
+        assert.true(chess.move("Nfd7"))
+        assert.true(chess.move("exd5"))
+        assert.true(chess.move("Bxd5"))
+        assert.true(chess.move("Bf3"))
+        assert.true(chess.move("c6"))
+        assert.true(chess.move("Ng3"))
+        assert.true(chess.move("Be7"))
+        assert.true(chess.move("O-O-O"))
+        assert.true(chess.move("Qg8"))
+        assert.equal(chess.fen(), "1rk1r1q1/pp1nb1pp/1np2p2/3bpP2/6P1/1N3BN1/PPPP3P/2KRR1BQ w kq - 4 10")
+
+    })
+
+    it("should load a chess960 game from a valid chess960 pgn", function () {
+        const pgn = `[Event "Freestyle Weissenhaus KO"]
+[Site "Wangels GER"]
+[Date "2025.02.09"]
+[EventDate "2025.02.09"]
+[Round "1.1"]
+[Result "1-0"]
+[White "Levon Aronian"]
+[Black "Vladimir Fedoseev"]
+[ECO "?"]
+[WhiteElo "?"]
+[BlackElo "?"]
+[PlyCount "72"]
+[Variant "Chess960"]
+[SetUp "1"]
+[FEN "nrkbrnbq/pppppppp/8/8/8/8/PPPPPPPP/NRKBRNBQ w KQkq - 0 1"]
+
+1. f4 Nb6 2. Nb3 f6 3. e4 e5 4. f5 d5 5. g4 Nfd7 6. exd5 Bxd5 7. Bf3 c6 8.
+Ng3 Be7 9. O-O-O Qg8 10. d3 Bb4 11. c3 Be7 12. c4 Bxf3 13. Qxf3 Qf7 14. Ne4
+O-O 15. Be3 Na4 16. Rg1 b5 17. c5 b4 18. Qf2 Rb5 19. Qc2 a5 20. d4 Ra8 21.
+g5 Kh8 22. gxf6 Bxf6 23. d5 cxd5 24. Nd6 Qf8 25. Nxb5 d4 26. c6 Rc8 27.
+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.fen(), "2rRn2k/2P3pp/8/pN3q2/8/1P6/1PQ4P/K5R1 b - - 0 36")
+    })
+})

package/test/index.html

@@ -18,6 +18,7 @@
 <script type="module">
     import {teevi} from "teevi/src/teevi.js"
     import "./TestChess.js"
+    import "./TestChess960.js"
     import "./TestFen.js"
     teevi.run()
 </script>