cm-engine-runner 1.2.4 → 2.0.1

package/README.md

@@ -4,28 +4,18 @@ A JavaScript module to act as a framework for running chess engines in the brows
 
 ## Working engines
 
-### Stockfish 10
+### Stockfish 18
 
-- File: `engines/stockfish-v10-niklasf.js`
-- Type: WebWorker
-- Stockfish version: 10
-- Latest Version with WebWorker
-- https://github.com/niklasf/stockfish.js
+- npm package: `stockfish` (v18.0.5)
+- File: `node_modules/stockfish/bin/stockfish-18-lite-single.js`
+- Type: WASM (single-threaded lite variant)
+- https://github.com/nmrugg/stockfish.js
 
 ### Polyglot opening books
 
 - An engine to play moves from a polyglot (.bin) openings file.
 - https://github.com/shaack/cm-polyglot
 
-### Stockfish 14
-
-Not implemented yet, does not work in Safari as of 2021-12-12
-
-- Type: WASM
-- Stockfish version: 14
-- Latest js version, multithreaded
-- https://github.com/nmrugg/stockfish.js
-
 ## Stockfish Skill Levels
 
     this.uciCmd('setoption name Skill Level value ' + (LEVELS[props.level][1]))

package/index.html

@@ -33,7 +33,7 @@
     const positionEndGame = "8/8/8/2k5/4K3/8/8/8"
     console.log("polyglot", positionEndGame, await polyglotRunner.calculateMove(positionEndGame))
 
-    const stockfishRunner = new StockfishRunner({workerUrl: "./node_modules/stockfish/src/stockfish-17.1-lite-single-03e3232.js", responseDelay: 0, debug: true})
+    const stockfishRunner = new StockfishRunner({workerUrl: "./node_modules/stockfish/bin/stockfish-18-lite-single.js", responseDelay: 0, debug: true})
     console.log("stockfish", await stockfishRunner.calculateMove(startingFewMoves))
     const postitionBlackWillWin = "4k3/3r4/8/8/8/8/6K1/8 w - - 0 1"
     console.log("stockfish",  await stockfishRunner.calculateMove(postitionBlackWillWin, {level: 1}))

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cm-engine-runner",
   "description": "Abstraction layer to run chess engines, supports opening books",
-  "version": "1.2.4",
+  "version": "2.0.1",
   "type": "module",
   "main": "index.js",
   "scripts": {
@@ -24,10 +24,10 @@
   },
   "homepage": "https://github.com/shaack/cm-chess-engine-adapter#readme",
   "devDependencies": {
-    "teevi": "^2.2.4"
+    "teevi": "^2.3.0"
   },
   "dependencies": {
     "cm-polyglot": "^1.1.0",
-    "stockfish": "^17.1.0"
+    "stockfish": "^18.0.5"
   }
 }

package/src/EngineRunner.js

@@ -22,10 +22,6 @@ export class EngineRunner {
         Object.assign(this.props, props)
         this.engineState = ENGINE_STATE.LOADING
         this.initialized = this.init()
-        /**
-         * @deprecated 2023-04-11 use `this.initialized` instead
-         */
-        this.initialization = this.initialized
     }
 
     init() {

package/src/StockfishRunner.js

@@ -37,9 +37,12 @@ export class StockfishRunner extends EngineRunner {
     }
 
     init() {
-        return new Promise((resolve) => {
+        return new Promise((resolve, reject) => {
             const listener = (event) => {
                 this.workerListener(event)
+                if (this.engineState === ENGINE_STATE.READY) {
+                    resolve()
+                }
             }
             if (this.engineWorker) {
                 this.engineWorker.removeEventListener("message", listener)
@@ -47,11 +50,13 @@ export class StockfishRunner extends EngineRunner {
             }
             this.engineWorker = new Worker(this.props.workerUrl)
             this.engineWorker.addEventListener("message", listener)
+            this.engineWorker.addEventListener("error", () => {
+                reject(new Error("Engine worker failed to load from: " + this.props.workerUrl))
+            })
 
             this.uciCmd('uci')
             this.uciCmd('ucinewgame')
             this.uciCmd('isready')
-            resolve()
         })
     }
 
@@ -80,8 +85,8 @@ export class StockfishRunner extends EngineRunner {
                 }
                 this.score = tmpScore
             }
-            // match = line.match(/^bestmove ([a-h][1-8])([a-h][1-8])([qrbk])?/) // ponder is not always included
-            match = line.match(/^bestmove ([a-h][1-8])([a-h][1-8])([qrbk])?( ponder ([a-h][1-8])?([a-h][1-8])?)?/)
+            // match = line.match(/^bestmove ([a-h][1-8])([a-h][1-8])([qrbn])?/) // ponder is not always included
+            match = line.match(/^bestmove ([a-h][1-8])([a-h][1-8])([qrbn])?( ponder ([a-h][1-8])?([a-h][1-8])?)?/)
             if (match) {
                 this.engineState = ENGINE_STATE.READY
                 if (match[4] !== undefined) {

package/.claude/settings.local.json

@@ -1,10 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(tree:*)",
-      "Bash(wc:*)",
-      "WebFetch(domain:github.com)",
-      "Bash(npm install:*)"
-    ]
-  }
-}

package/CLAUDE.md

@@ -1,57 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Project Overview
-
-cm-engine-runner is a lightweight JavaScript library for running chess engines in the browser. It provides an abstraction layer supporting multiple backends: Stockfish (via WebWorkers) and Polyglot opening books.
-
-## Development Commands
-
-```bash
-# Install dependencies
-npm install
-
-# Run the demo/test page
-# Open index.html in a browser (uses importmap for ES6 module resolution)
-```
-
-No build step is required - the library uses pure ES6 modules that run directly in browsers.
-
-## Architecture
-
-The project uses an **adapter pattern** with a base class and engine-specific implementations:
-
-```
-EngineRunner (base class)
-    ├── StockfishRunner  →  WebWorker  →  Stockfish WASM engine
-    └── PolyglotRunner   →  cm-polyglot  →  Opening book (.bin)
-```
-
-### Core Files
-
-- `src/EngineRunner.js` - Abstract base class defining the interface and state machine (`ENGINE_STATE`: LOADING, LOADED, READY, THINKING)
-- `src/StockfishRunner.js` - Stockfish adapter implementing UCI protocol communication, skill levels 1-20 with depth mapping
-- `src/PolyglotRunner.js` - Polyglot opening book reader with probability-weighted move selection
-- `engines/stockfish-v10-niklasf.js` - Compiled Stockfish v10 engine (runs in WebWorker)
-
-### API Pattern
-
-All adapters share this interface:
-```javascript
-runner.calculateMove(fen, props) → Promise<{from, to, promotion?, score?, ponder?}>
-```
-
-### Adding a New Engine
-
-1. Extend `EngineRunner` class
-2. Implement `init()` to set up the engine
-3. Implement `calculateMove(fen, props)` returning a Promise with move data
-4. Manage engine state via `ENGINE_STATE` constants
-
-## Key Implementation Details
-
-- Uses `importmap` in index.html for browser-based ES6 module resolution (no bundler)
-- StockfishRunner communicates with the engine via `postMessage` using UCI protocol
-- `responseDelay` prop adds artificial delay for UX purposes
-- `debug` prop enables console logging