t3core 1.0.3 → 1.1.0

package/dist/src/core/Board.d.ts

@@ -14,8 +14,16 @@ export declare class Board implements IBoard {
      * @param fieldNumber The field number (1-9) to get.
      * @returns The value of the field.
      * @type {number | TSymbol}
+     * @deprecated Use `getFieldByIndex` instead.
      */
     getFieldByNumber(fieldNumber: number): number | "O" | "X";
+    /**
+     * Returns the value of a field by its index.
+     * @param index The index of the field to get.
+     * @returns The value of the field.
+     * @type {number | TSymbol}
+     */
+    getFieldByIndex(index: number): number | "O" | "X";
     /**
      * Checks if the board is full.
      * @returns `true` if the board is full, `false` otherwise.
@@ -25,8 +33,15 @@ export declare class Board implements IBoard {
      * Sets a field's value by its number.
      * @param fieldNumber The field number (1-9) to set.
      * @param symbol The symbol to set.
+     * @deprecated Use `setFieldByIndex` instead.
      */
     setFieldByNumber(fieldNumber: number, symbol: PlayerSymbol): void;
+    /**
+     * Sets a field's value by its index.
+     * @param index The index of the field to set.
+     * @param symbol The symbol to set.
+     */
+    setFieldByIndex(index: number, symbol: PlayerSymbol): void;
     /**
      * Resets the board to its initial state.
      */

package/dist/src/core/Board.js

@@ -22,10 +22,20 @@ class Board {
      * @param fieldNumber The field number (1-9) to get.
      * @returns The value of the field.
      * @type {number | TSymbol}
+     * @deprecated Use `getFieldByIndex` instead.
      */
     getFieldByNumber(fieldNumber) {
         return this.fields[fieldNumber - 1];
     }
+    /**
+     * Returns the value of a field by its index.
+     * @param index The index of the field to get.
+     * @returns The value of the field.
+     * @type {number | TSymbol}
+     */
+    getFieldByIndex(index) {
+        return this.fields[index];
+    }
     /**
      * Checks if the board is full.
      * @returns `true` if the board is full, `false` otherwise.
@@ -37,10 +47,19 @@ class Board {
      * Sets a field's value by its number.
      * @param fieldNumber The field number (1-9) to set.
      * @param symbol The symbol to set.
+     * @deprecated Use `setFieldByIndex` instead.
      */
     setFieldByNumber(fieldNumber, symbol) {
         this.fields[fieldNumber - 1] = symbol;
     }
+    /**
+     * Sets a field's value by its index.
+     * @param index The index of the field to set.
+     * @param symbol The symbol to set.
+     */
+    setFieldByIndex(index, symbol) {
+        this.fields[index] = symbol;
+    }
     /**
      * Resets the board to its initial state.
      */

package/dist/src/core/Game.d.ts

@@ -1,10 +1,11 @@
-import type { GameStatus, IGame } from "./types/Game";
 import type { PlayerSymbol } from "./types/Symbol";
+import { type EventEmitHandler, type GameEventMap, type GameStatus, type IGame } from "./types/Game";
 export declare class Game implements IGame {
     private _currentPlayer;
     private _gameStatus;
     private _symbols;
     private _board;
+    private _emitter;
     private _togglePlayer;
     private _updateGameStatus;
     /**
@@ -23,20 +24,56 @@ export declare class Game implements IGame {
      * @returns The current board state.
      * @type {(number | PlayerSymbol)[]}
      */
+    get board(): (number | "O" | "X")[];
+    /**
+     * Registers an event listener for the specified event.
+     * @param event The event to listen for.
+     * @param fn The function to call when the event is emitted.
+     * @returns This Game instance for method chaining.
+     */
+    on<K extends keyof GameEventMap>({ event, fn }: EventEmitHandler<K>): this;
+    /**
+     * Removes an event listener for the specified event.
+     * @param event The event to remove the listener from.
+     * @param fn The function to remove.
+     * @returns This Game instance for method chaining.
+     */
+    off<K extends keyof GameEventMap>({ event, fn }: EventEmitHandler<K>): this;
+    /**
+     * Returns the current board state.
+     * @returns The current board state.
+     * @type {(number | PlayerSymbol)[]}
+     * @deprecated Use `board` instead.
+     */
     getBoard(): (number | "O" | "X")[];
     /**
      * Checks if a field is already selected by a player.
      * @param field The field number to check.
      * @returns `true` if the field is selected, `false` otherwise.
+     * @deprecated Use `isFieldSelectedByIndex` instead.
      */
     isFieldSelected(field: number): boolean;
+    /**
+     * Checks if a field is already selected by a player.
+     * @param index The index of the field to check.
+     * @returns `true` if the field is selected, `false` otherwise.
+     */
+    isFieldSelectedByIndex(index: number): boolean;
     /**
      * Saves a player's selection on the board.
      * @param field The field number to mark.
+     * @deprecated Use `savePlayerMove` instead.
      */
     savePlayerSelection(field: number): void;
+    /**
+     * Saves a player's selection on the board by index.
+     * emit PLAYER_MOVE event
+     * @param index The index of the field to mark.
+     */
+    savePlayerMove(index: number): "success" | "already_selected" | "game_not_running";
     /**
      * Resets the game to its initial state.
+     * emit RESET event
      */
     reset(): void;
 }

package/dist/src/core/Game.js

@@ -1,8 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Game = void 0;
+const eventemitter3_1 = __importDefault(require("eventemitter3"));
 const Board_1 = require("./Board");
 const constants_1 = require("./constants");
+const Game_1 = require("./types/Game");
 const getWinnerFromFields_1 = require("./utils/getWinnerFromFields");
 class Game {
     constructor() {
@@ -10,6 +15,7 @@ class Game {
         this._gameStatus = { status: "running" };
         this._symbols = constants_1.DEFAULT_GAME_SYMBOLS;
         this._board = new Board_1.Board();
+        this._emitter = new eventemitter3_1.default();
     }
     _togglePlayer() {
         this._currentPlayer =
@@ -51,6 +57,35 @@ class Game {
      * @returns The current board state.
      * @type {(number | PlayerSymbol)[]}
      */
+    get board() {
+        return this._board.getFields();
+    }
+    /**
+     * Registers an event listener for the specified event.
+     * @param event The event to listen for.
+     * @param fn The function to call when the event is emitted.
+     * @returns This Game instance for method chaining.
+     */
+    on({ event, fn }) {
+        this._emitter.on(event, fn);
+        return this;
+    }
+    /**
+     * Removes an event listener for the specified event.
+     * @param event The event to remove the listener from.
+     * @param fn The function to remove.
+     * @returns This Game instance for method chaining.
+     */
+    off({ event, fn }) {
+        this._emitter.off(event, fn);
+        return this;
+    }
+    /**
+     * Returns the current board state.
+     * @returns The current board state.
+     * @type {(number | PlayerSymbol)[]}
+     * @deprecated Use `board` instead.
+     */
     getBoard() {
         return this._board.getFields();
     }
@@ -58,26 +93,67 @@ class Game {
      * Checks if a field is already selected by a player.
      * @param field The field number to check.
      * @returns `true` if the field is selected, `false` otherwise.
+     * @deprecated Use `isFieldSelectedByIndex` instead.
      */
     isFieldSelected(field) {
         return typeof this._board.getFieldByNumber(field) === "string";
     }
+    /**
+     * Checks if a field is already selected by a player.
+     * @param index The index of the field to check.
+     * @returns `true` if the field is selected, `false` otherwise.
+     */
+    isFieldSelectedByIndex(index) {
+        return typeof this._board.getFieldByIndex(index) === "string";
+    }
     /**
      * Saves a player's selection on the board.
      * @param field The field number to mark.
+     * @deprecated Use `savePlayerMove` instead.
      */
     savePlayerSelection(field) {
         this._board.setFieldByNumber(field, this._currentPlayer);
         this._togglePlayer();
         this._updateGameStatus();
     }
+    /**
+     * Saves a player's selection on the board by index.
+     * emit PLAYER_MOVE event
+     * @param index The index of the field to mark.
+     */
+    savePlayerMove(index) {
+        if (this.isFieldSelected(index + 1)) {
+            console.warn("Field is already selected");
+            return Game_1.PlayerMoveStatus.ALREADY_SELECTED;
+        }
+        if (this._gameStatus.status !== "running") {
+            console.warn("Game is not running");
+            return Game_1.PlayerMoveStatus.GAME_NOT_RUNNING;
+        }
+        this._board.setFieldByIndex(index, this._currentPlayer);
+        this._togglePlayer();
+        this._updateGameStatus();
+        this._emitter.emit(Game_1.GameEvent.PLAYER_MOVE, {
+            index,
+            board: this._board.getFields(),
+            currentPlayer: this._currentPlayer,
+            gameStatus: this._gameStatus,
+        });
+        return Game_1.PlayerMoveStatus.SUCCESS;
+    }
     /**
      * Resets the game to its initial state.
+     * emit RESET event
      */
     reset() {
         this._gameStatus = { status: "running" };
         this._currentPlayer = this._symbols[0];
         this._board.reset();
+        this._emitter.emit(Game_1.GameEvent.RESET, {
+            board: this._board.getFields(),
+            currentPlayer: this._currentPlayer,
+            gameStatus: this._gameStatus,
+        });
     }
 }
 exports.Game = Game;

package/dist/src/core/index.d.ts

@@ -11,6 +11,14 @@ export { DEFAULT_GAME_SYMBOLS } from "./constants";
  * Interface describing the Game class contract.
  */
 export type { IGame } from "./types/Game";
+/**
+ * Game event names: `PLAYER_MOVE`, `RESET`.
+ */
+export { GameEvent } from "./types/Game";
+/**
+ * Typed event map for EventEmitter3 — use with `Game` listeners.
+ */
+export type { GameEventMap, GameEventPayload } from "./types/Game";
 /**
  * Union type representing possible game states:
  * - `{ status: 'running' }` - Game in progress

package/dist/src/core/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_GAME_SYMBOLS = exports.Game = void 0;
+exports.GameEvent = exports.DEFAULT_GAME_SYMBOLS = exports.Game = void 0;
 /**
  * Core game logic for Tic Tac Toe.
  * Manages player turns, board state, win/draw detection, and game lifecycle.
@@ -12,3 +12,8 @@ Object.defineProperty(exports, "Game", { enumerable: true, get: function () { re
  */
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "DEFAULT_GAME_SYMBOLS", { enumerable: true, get: function () { return constants_1.DEFAULT_GAME_SYMBOLS; } });
+/**
+ * Game event names: `PLAYER_MOVE`, `RESET`.
+ */
+var Game_2 = require("./types/Game");
+Object.defineProperty(exports, "GameEvent", { enumerable: true, get: function () { return Game_2.GameEvent; } });

package/dist/src/core/tests/gameCore.test.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const vitest_1 = require("vitest");
 const Game_1 = require("../Game");
+const Game_2 = require("../types/Game");
 /*
     O   X   O
     O   X   X
@@ -9,26 +10,26 @@ const Game_1 = require("../Game");
 */
 (0, vitest_1.test)("Check if the game ends in a draw", () => {
     const game = new Game_1.Game();
-    game.savePlayerSelection(1);
-    game.savePlayerSelection(2);
-    game.savePlayerSelection(3);
-    game.savePlayerSelection(5);
-    game.savePlayerSelection(4);
-    game.savePlayerSelection(6);
-    game.savePlayerSelection(8);
-    game.savePlayerSelection(7);
-    game.savePlayerSelection(9);
+    game.savePlayerMove(0);
+    game.savePlayerMove(1);
+    game.savePlayerMove(2);
+    game.savePlayerMove(4);
+    game.savePlayerMove(3);
+    game.savePlayerMove(5);
+    game.savePlayerMove(7);
+    game.savePlayerMove(6);
+    game.savePlayerMove(8);
     (0, vitest_1.expect)(game.gameStatus).toEqual({ status: "draw" });
 });
 (0, vitest_1.test)("Reset the game", () => {
     const game = new Game_1.Game();
-    game.savePlayerSelection(5);
-    game.savePlayerSelection(1);
-    game.savePlayerSelection(2);
-    game.savePlayerSelection(3);
-    game.savePlayerSelection(8);
+    game.savePlayerMove(4);
+    game.savePlayerMove(0);
+    game.savePlayerMove(1);
+    game.savePlayerMove(2);
+    game.savePlayerMove(7);
     game.reset();
-    (0, vitest_1.expect)(game.getBoard()).toEqual(new Array(9).fill(0).map((_, idx) => idx + 1));
+    (0, vitest_1.expect)(game.board).toEqual(new Array(9).fill(0).map((_, idx) => idx + 1));
     (0, vitest_1.expect)(game.gameStatus.status).toBe("running");
     (0, vitest_1.expect)(game.currentPlayer).toBe("O");
 });
@@ -39,12 +40,45 @@ const Game_1 = require("../Game");
 */
 (0, vitest_1.test)("Check if the game is won", () => {
     const game = new Game_1.Game();
-    game.savePlayerSelection(5);
-    game.savePlayerSelection(1);
-    game.savePlayerSelection(2);
-    game.savePlayerSelection(3);
-    game.savePlayerSelection(8);
+    game.savePlayerMove(4);
+    game.savePlayerMove(0);
+    game.savePlayerMove(1);
+    game.savePlayerMove(2);
+    game.savePlayerMove(7);
     (0, vitest_1.expect)(game.gameStatus).toEqual({ status: "win", winner: "O" });
-    (0, vitest_1.expect)(game.isFieldSelected(5)).toBe(true);
-    (0, vitest_1.expect)(game.isFieldSelected(9)).toBe(false);
+    (0, vitest_1.expect)(game.isFieldSelectedByIndex(4)).toBe(true);
+    (0, vitest_1.expect)(game.isFieldSelectedByIndex(8)).toBe(false);
+});
+(0, vitest_1.test)("PLAYER_MOVE event fires with correct payload on savePlayerMove", () => {
+    const game = new Game_1.Game();
+    const listener = vitest_1.vi.fn();
+    game.on({ event: Game_2.GameEvent.PLAYER_MOVE, fn: listener });
+    game.savePlayerMove(4);
+    (0, vitest_1.expect)(listener).toHaveBeenCalledOnce();
+    const payload = listener.mock.calls[0][0];
+    (0, vitest_1.expect)(payload.index).toBe(4);
+    (0, vitest_1.expect)(payload.board[4]).toBe("O");
+    (0, vitest_1.expect)(payload.currentPlayer).toBe("X");
+    (0, vitest_1.expect)(payload.gameStatus).toEqual({ status: "running" });
+});
+(0, vitest_1.test)("RESET event fires with correct payload", () => {
+    const game = new Game_1.Game();
+    game.savePlayerMove(0);
+    game.savePlayerMove(1);
+    const listener = vitest_1.vi.fn();
+    game.on({ event: Game_2.GameEvent.RESET, fn: listener });
+    game.reset();
+    (0, vitest_1.expect)(listener).toHaveBeenCalledOnce();
+    const payload = listener.mock.calls[0][0];
+    (0, vitest_1.expect)(payload.board).toEqual(new Array(9).fill(0).map((_, idx) => idx + 1));
+    (0, vitest_1.expect)(payload.currentPlayer).toBe("O");
+    (0, vitest_1.expect)(payload.gameStatus).toEqual({ status: "running" });
+});
+(0, vitest_1.test)("PLAYER_MOVE event is not fired when move is invalid", () => {
+    const game = new Game_1.Game();
+    game.savePlayerMove(0);
+    const listener = vitest_1.vi.fn();
+    game.on({ event: Game_2.GameEvent.PLAYER_MOVE, fn: listener });
+    game.savePlayerMove(0);
+    (0, vitest_1.expect)(listener).not.toHaveBeenCalled();
 });

package/dist/src/core/types/Game.d.ts

@@ -10,12 +10,43 @@ type GameStatusRunning = {
     status: "running";
 };
 export type GameStatus = GameStatusWin | GameStatusDraw | GameStatusRunning;
+export declare const PlayerMoveStatus: {
+    readonly SUCCESS: "success";
+    readonly ALREADY_SELECTED: "already_selected";
+    readonly GAME_NOT_RUNNING: "game_not_running";
+};
+export type PlayerMoveStatus = (typeof PlayerMoveStatus)[keyof typeof PlayerMoveStatus];
+export declare const GameEvent: {
+    readonly PLAYER_MOVE: "PLAYER_MOVE";
+    readonly RESET: "RESET";
+};
+export type GameEvent = (typeof GameEvent)[keyof typeof GameEvent];
+export type GameEventPayload = {
+    board: (number | PlayerSymbol)[];
+    currentPlayer: PlayerSymbol;
+    gameStatus: GameStatus;
+};
+export type GameEventMap = {
+    [GameEvent.PLAYER_MOVE]: [payload: GameEventPayload & {
+        index: number;
+    }];
+    [GameEvent.RESET]: [payload: GameEventPayload];
+};
+export type EventEmitHandler<K extends keyof GameEventMap> = {
+    event: K;
+    fn: (...args: GameEventMap[K]) => void;
+};
+export type EventEmit = <K extends keyof GameEventMap>(emitter: EventEmitHandler<K>) => void;
 export interface IGame {
+    on: EventEmit;
+    off: EventEmit;
     readonly gameStatus: GameStatus;
     readonly currentPlayer: PlayerSymbol;
     savePlayerSelection: (field: number) => void;
     reset: () => void;
     isFieldSelected: (field: number) => boolean;
+    isFieldSelectedByIndex: (index: number) => boolean;
+    savePlayerMove: (index: number) => PlayerMoveStatus;
     getBoard: () => (number | PlayerSymbol)[];
 }
 export {};

package/dist/src/core/types/Game.js

@@ -1,2 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GameEvent = exports.PlayerMoveStatus = void 0;
+exports.PlayerMoveStatus = {
+    SUCCESS: "success",
+    ALREADY_SELECTED: "already_selected",
+    GAME_NOT_RUNNING: "game_not_running",
+};
+exports.GameEvent = {
+    PLAYER_MOVE: "PLAYER_MOVE",
+    RESET: "RESET",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "t3core",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "tic tac toe core - tttc - t3c",
   "main": "dist/index.js",
   "scripts": {
@@ -10,7 +10,8 @@
     "test": "vitest",
     "lint": "eslint ./src/**/*.ts",
     "ts:check": "tsc --noEmit",
-    "publish:package": "npm version patch && npm publish"
+    "publish:dry": "npm run build && npm publish --dry-run",
+    "release:tag": "env -i HOME=$HOME PATH=$PATH bash scripts/release.sh"
   },
   "keywords": [
     "tic-tac-toe",
@@ -59,5 +60,8 @@
     "typescript": "^6.0.3",
     "typescript-eslint": "^8.59.1",
     "vitest": "^4.1.5"
+  },
+  "dependencies": {
+    "eventemitter3": "^5.0.4"
   }
 }