Skip to content

Latest commit

 

History

History
121 lines (91 loc) · 4.36 KB

CHANGELOG.md

File metadata and controls

121 lines (91 loc) · 4.36 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[3.0.2] - 2026-03-15

Added

  • Events and GoOptions are now re-exported from the package root — consumers can import them directly: import UCI, { type GoOptions } from '@echecs/uci'

Fixed

  • start() no longer re-sends setoption commands on every call — engine config is now applied exactly once after the UCI handshake

[3.0.1] - 2026-03-15

Fixed

  • README updated to reflect v3.0.0 API (constructor config option, GoOptions, pondering, corrected stop()/reset() descriptions, sbhits in InfoCommand)
  • CHANGELOG: moved reset() and stop() entries from Added to Changed

[3.0.0] - 2026-03-15

Added

  • GoOptions interface — typed parameters for go command: wtime, btime, winc, binc, movestogo, movetime, nodes, mate, searchmoves, depth
  • start(options?: GoOptions) — time controls and search limits as typed options
  • move(input, options?: GoOptions) — per-move time controls forwarded to go
  • Constructor config option — setoption overrides applied once after UCI handshake: new UCI(path, { config: { Hash: 64 } })
  • ponder(move, options?) — sends go ponder for pondering on a move; guards against double-call
  • ponderhit() — commits ponder move, switches engine from ponder to normal search
  • sbhits field on InfoCommand — Shredder endgame database hits

Changed

  • start() parameter changed from Record<string, unknown> (setoptions) to GoOptions (search parameters) — breaking change
  • Engine setoption overrides now passed via constructor config option instead of start() argument
  • reset() now sends ucinewgame before position startpos
  • stop() now clears pondering state

Migration from v2

// v2
const uci = new UCI('/path/to/engine');
await uci.start({ MultiPV: 4, Hash: 128 });

// v3
const uci = new UCI('/path/to/engine', { config: { Hash: 128 } });
uci.lines = 4; // MultiPV is still set via the lines property
await uci.start(); // no args needed for engine config
await uci.start({ movetime: 1000 }); // time-controlled search

[2.0.0] - 2026-03-15

Added

  • debug(on) — sends debug on / debug off to the engine
  • Events interface exported from src/types.ts — consumers can now type their listeners directly
  • [Symbol.dispose]() — sends quit and terminates the engine process (replaces using stop() for shutdown)
  • stop() — now correctly sends stop (halts search, keeps engine alive)

Changed

  • UCI no longer extends Emittery — the public event API is now limited to explicit on(), off(), and once() methods. Emittery internals (onAny, offAny, anyEvent, clearListeners, listenerCount, bindMethods) are no longer accessible.
  • ready() now fails fast on process exit or timeout instead of hanging indefinitely — errors are emitted on the 'error' event

Fixed

  • stop() was sending quit instead of stop
  • combo option var values were parsed as a single string instead of an array, breaking option validation
  • lowerbound/upperbound score flags now parsed order-independently
  • start() now emits an error instead of throwing when the engine handshake fails

[1.0.0] - 2026-03-13

Initial public release.

Added

  • UCI class — wraps a UCI chess engine process with a typed event-emitter API
  • Full UCI handshake (uci, isready, uciok, readyok)
  • start(options?) — applies setoption overrides and sends go
  • move(move) — sends a move in long algebraic notation and restarts search
  • stop() — sends quit and terminates the engine process
  • reset() — resets position to startpos
  • execute(command) — sends an arbitrary UCI command string
  • depth and lines properties for controlling search parameters
  • position setter for FEN or startpos
  • Typed info events: depth, selective depth, score (cp/mate with lowerbound/upperbound), PV moves, nodes, NPS, time, hashfull, CPU load
  • Typed bestmove, id, option, copyprotection, registration, error, output, readyok, uciok events
  • Engine option validation via Zod schemas