t3core 1.0.0

package/README.md

@@ -0,0 +1,69 @@
+# TIC-TAC-TOE-CORE (t3c)
+
+A reusable TypeScript core library for Tic Tac Toe games with a built-in CLI.
+
+## Installation
+
+```bash
+npm install t3c
+```
+
+## Usage as a Library
+
+```typescript
+import { Game } from 't3c';
+
+// Create a game with default symbols 'O' and 'X'
+const game = new Game();
+
+// Make a move (field 1-9)
+game.savePlayerSelection(5);
+
+// Check game status
+console.log(game.gameStatus); // { status: 'running' } | { status: 'win', winner: 'O' } | { status: 'draw' }
+console.log(game.currentPlayer); // 'O' or 'X'
+
+// Check if field is already selected
+console.log(game.isFieldSelected(5)); // true
+
+// Access the board
+console.log(game.getBoard()); // [1, 2, 3, 4, 'O', 6, 7, 8, 9]
+
+// Reset the game
+game.reset();
+```
+
+### API
+
+#### `Game`
+
+| Property/Method | Description                    |
+| --------------- | ------------------------------ |
+| `constructor()` | Create a new game with default symbols `['O', 'X']` |
+| `currentPlayer` | Get the current player's symbol              |
+| `gameStatus`    | Get current game status                      |
+| `getBoard()`    | Returns the current board state as `(number \| PlayerSymbol)[]`       |
+| `savePlayerSelection(field: number)` | Place current player's symbol on field 1-9   |
+| `isFieldSelected(field: number)` | Check if a field is already occupied           |
+| `reset()`       | Reset the game to initial state              |
+
+## CLI Usage
+
+Run the interactive console game:
+
+```bash
+npx tic-tac-toe-core
+```
+
+## Exports
+
+```typescript
+// Core class
+export { Game } from 't3c';
+
+// Constants
+export { DEFAULT_GAME_SYMBOLS } from 't3c';
+
+// Types
+export type { IGame, GameStatus, PlayerSymbol, PlayerSymbols } from 't3c';
+```

package/dist/eslint.config.d.mts

@@ -0,0 +1,2 @@
+declare const _default: import("eslint/config").Config[];
+export default _default;

package/dist/eslint.config.mjs

@@ -0,0 +1,86 @@
+import js from "@eslint/js";
+import { importX } from "eslint-plugin-import-x";
+import perfectionist from "eslint-plugin-perfectionist";
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import path from "path";
+import tseslint from "typescript-eslint";
+import { fileURLToPath } from "url";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export default defineConfig([
+    {
+        ignores: ["dist/**", "node_modules/**"],
+    },
+    {
+        languageOptions: {
+            parserOptions: {
+                tsconfigRootDir: __dirname,
+            },
+        },
+    },
+    {
+        files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+        plugins: { js },
+        extends: ["js/recommended"],
+        languageOptions: { globals: globals.browser },
+    },
+    tseslint.configs.recommended,
+    {
+        plugins: {
+            "import-x": importX,
+            perfectionist,
+        },
+        settings: {
+            "import-x/internal-regex": "^@/",
+            "import-x/resolver": {
+                typescript: true,
+            },
+        },
+        rules: {
+            "no-case-declarations": "off",
+            "@typescript-eslint/consistent-type-imports": [
+                "error",
+                {
+                    prefer: "type-imports",
+                    fixStyle: "separate-type-imports",
+                },
+            ],
+            "@typescript-eslint/no-explicit-any": "warn",
+            "@typescript-eslint/no-unused-vars": [
+                "error",
+                {
+                    argsIgnorePattern: "^_",
+                    varsIgnorePattern: "^_",
+                    caughtErrorsIgnorePattern: "^_",
+                },
+            ],
+            "no-console": "off",
+            "perfectionist/sort-imports": [
+                "error",
+                {
+                    type: "alphabetical",
+                    order: "asc",
+                    ignoreCase: true,
+                    newlinesBetween: 1,
+                    tsconfig: { rootDir: "." },
+                    internalPattern: ["^@/"],
+                    groups: [
+                        "type-import",
+                        ["value-builtin", "value-external"],
+                        "value-internal",
+                        ["value-parent", "value-sibling", "value-index"],
+                        "side-effect",
+                        "unknown",
+                    ],
+                },
+            ],
+            "import-x/no-cycle": [
+                "error",
+                {
+                    ignoreExternal: true,
+                },
+            ],
+        },
+    },
+]);

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const app_1 = require("./src/app");
+(0, app_1.app)();

package/dist/src/app.d.ts

@@ -0,0 +1 @@
+export declare const app: () => void;

package/dist/src/app.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.app = void 0;
+const navigation_1 = require("./ui/navigation");
+const routes_1 = require("./ui/navigation/routes");
+const app = () => {
+    (0, navigation_1.navigateTo)(routes_1.ROUTES.MENU);
+};
+exports.app = app;

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

@@ -0,0 +1,34 @@
+import type { IBoard } from "./types/Board";
+import type { PlayerSymbol } from "./types/Symbol";
+export declare const BOARD_SIZE = 9;
+export declare class Board implements IBoard {
+    private fields;
+    /**
+     * Returns the current board state.
+     * @returns The current board state.
+     * @type {number[] | PlayerSymbol[]}
+     */
+    getFields(): (number | "O" | "X")[];
+    /**
+     * Returns the value of a field by its number.
+     * @param fieldNumber The field number (1-9) to get.
+     * @returns The value of the field.
+     * @type {number | TSymbol}
+     */
+    getFieldByNumber(fieldNumber: number): number | "O" | "X";
+    /**
+     * Checks if the board is full.
+     * @returns `true` if the board is full, `false` otherwise.
+     */
+    isFull(): boolean;
+    /**
+     * Sets a field's value by its number.
+     * @param fieldNumber The field number (1-9) to set.
+     * @param symbol The symbol to set.
+     */
+    setFieldByNumber(fieldNumber: number, symbol: PlayerSymbol): void;
+    /**
+     * Resets the board to its initial state.
+     */
+    reset(): void;
+}

package/dist/src/core/Board.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Board = exports.BOARD_SIZE = void 0;
+const fillFields = (_, idx) => idx + 1;
+exports.BOARD_SIZE = 9;
+class Board {
+    constructor() {
+        this.fields = new Array(exports.BOARD_SIZE)
+            .fill(0)
+            .map(fillFields);
+    }
+    /**
+     * Returns the current board state.
+     * @returns The current board state.
+     * @type {number[] | PlayerSymbol[]}
+     */
+    getFields() {
+        return this.fields;
+    }
+    /**
+     * Returns the value of a field by its number.
+     * @param fieldNumber The field number (1-9) to get.
+     * @returns The value of the field.
+     * @type {number | TSymbol}
+     */
+    getFieldByNumber(fieldNumber) {
+        return this.fields[fieldNumber - 1];
+    }
+    /**
+     * Checks if the board is full.
+     * @returns `true` if the board is full, `false` otherwise.
+     */
+    isFull() {
+        return this.fields.every((field) => typeof field === "string");
+    }
+    /**
+     * Sets a field's value by its number.
+     * @param fieldNumber The field number (1-9) to set.
+     * @param symbol The symbol to set.
+     */
+    setFieldByNumber(fieldNumber, symbol) {
+        this.fields[fieldNumber - 1] = symbol;
+    }
+    /**
+     * Resets the board to its initial state.
+     */
+    reset() {
+        this.fields = new Array(exports.BOARD_SIZE).fill(0).map(fillFields);
+    }
+}
+exports.Board = Board;

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

@@ -0,0 +1,42 @@
+import type { GameStatus, IGame } from "./types/Game";
+import type { PlayerSymbol } from "./types/Symbol";
+export declare class Game implements IGame {
+    private _currentPlayer;
+    private _gameStatus;
+    private _symbols;
+    private _board;
+    private _togglePlayer;
+    private _updateGameStatus;
+    /**
+     * Returns the current player.
+     * @returns The current player.
+     */
+    get currentPlayer(): PlayerSymbol;
+    /**
+     * Returns the current game status.
+     * @returns The current game status.
+     * @type {GameStatus<PlayerSymbol>}
+     */
+    get gameStatus(): GameStatus;
+    /**
+     * Returns the current board state.
+     * @returns The current board state.
+     * @type {(number | PlayerSymbol)[]}
+     */
+    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.
+     */
+    isFieldSelected(field: number): boolean;
+    /**
+     * Saves a player's selection on the board.
+     * @param field The field number to mark.
+     */
+    savePlayerSelection(field: number): void;
+    /**
+     * Resets the game to its initial state.
+     */
+    reset(): void;
+}

package/dist/src/core/Game.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Game = void 0;
+const Board_1 = require("./Board");
+const constants_1 = require("./constants");
+const getWinnerFromFields_1 = require("./utils/getWinnerFromFields");
+class Game {
+    constructor() {
+        this._currentPlayer = constants_1.DEFAULT_GAME_SYMBOLS[0];
+        this._gameStatus = { status: "running" };
+        this._symbols = constants_1.DEFAULT_GAME_SYMBOLS;
+        this._board = new Board_1.Board();
+    }
+    _togglePlayer() {
+        this._currentPlayer =
+            this._currentPlayer === this._symbols[0]
+                ? this._symbols[1]
+                : this._symbols[0];
+    }
+    _updateGameStatus() {
+        const board = this._board;
+        const winner = (0, getWinnerFromFields_1.getWinnerFromFields)(board.getFields());
+        const isDraw = board.isFull() && !winner;
+        if (winner) {
+            this._gameStatus = { status: "win", winner };
+            return;
+        }
+        if (isDraw) {
+            this._gameStatus = { status: "draw" };
+            return;
+        }
+        this._gameStatus = { status: "running" };
+    }
+    /**
+     * Returns the current player.
+     * @returns The current player.
+     */
+    get currentPlayer() {
+        return this._currentPlayer;
+    }
+    /**
+     * Returns the current game status.
+     * @returns The current game status.
+     * @type {GameStatus<PlayerSymbol>}
+     */
+    get gameStatus() {
+        return this._gameStatus;
+    }
+    /**
+     * Returns the current board state.
+     * @returns The current board state.
+     * @type {(number | PlayerSymbol)[]}
+     */
+    getBoard() {
+        return this._board.getFields();
+    }
+    /**
+     * 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.
+     */
+    isFieldSelected(field) {
+        return typeof this._board.getFieldByNumber(field) === "string";
+    }
+    /**
+     * Saves a player's selection on the board.
+     * @param field The field number to mark.
+     */
+    savePlayerSelection(field) {
+        this._board.setFieldByNumber(field, this._currentPlayer);
+        this._togglePlayer();
+        this._updateGameStatus();
+    }
+    /**
+     * Resets the game to its initial state.
+     */
+    reset() {
+        this._gameStatus = { status: "running" };
+        this._currentPlayer = this._symbols[0];
+        this._board.reset();
+    }
+}
+exports.Game = Game;

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

@@ -0,0 +1,2 @@
+export declare const WINNING_COMBINATIONS_INDEXES: number[][];
+export declare const DEFAULT_GAME_SYMBOLS: readonly ["O", "X"];

package/dist/src/core/constants/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_GAME_SYMBOLS = exports.WINNING_COMBINATIONS_INDEXES = void 0;
+exports.WINNING_COMBINATIONS_INDEXES = [
+    [0, 1, 2],
+    [3, 4, 5],
+    [6, 7, 8],
+    [0, 3, 6],
+    [1, 4, 7],
+    [2, 5, 8],
+    [0, 4, 8],
+    [2, 4, 6],
+];
+exports.DEFAULT_GAME_SYMBOLS = ["O", "X"];

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

@@ -0,0 +1,30 @@
+/**
+ * Core game logic for Tic Tac Toe.
+ * Manages player turns, board state, win/draw detection, and game lifecycle.
+ */
+export { Game } from "./Game";
+/**
+ * Default player symbols ['O', 'X'] for convenience.
+ */
+export { DEFAULT_GAME_SYMBOLS } from "./constants";
+/**
+ * Interface describing the Game class contract.
+ */
+export type { IGame } from "./types/Game";
+/**
+ * Union type representing possible game states:
+ * - `{ status: 'running' }` - Game in progress
+ * - `{ status: 'win', winner: TSymbol }` - A player won
+ * - `{ status: 'draw' }` - Board full, no winner
+ */
+export type { GameStatus } from "./types/Game";
+/**
+ * Tuple type for player symbols: `[symbol1, symbol2]`.
+ *
+ * @example
+ * ```ts
+ * type Symbols = ['O', 'X']; // PlayerSymbols
+ * type Symbol = 'O' | 'X';   // PlayerSymbol
+ * ```
+ */
+export type { PlayerSymbols, PlayerSymbol } from "./types/Symbol";

package/dist/src/core/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ */
+var Game_1 = require("./Game");
+Object.defineProperty(exports, "Game", { enumerable: true, get: function () { return Game_1.Game; } });
+/**
+ * Default player symbols ['O', 'X'] for convenience.
+ */
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "DEFAULT_GAME_SYMBOLS", { enumerable: true, get: function () { return constants_1.DEFAULT_GAME_SYMBOLS; } });

package/dist/src/core/tests/gameCore.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const Game_1 = require("../Game");
+/*
+    O   X   O
+    O   X   X
+    X   O   O
+*/
+(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);
+    (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.reset();
+    (0, vitest_1.expect)(game.getBoard()).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");
+});
+/*
+    X   O   X
+    4   O   6
+    7   O   9
+*/
+(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);
+    (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);
+});

package/dist/src/core/tests/getWinnerFromFields.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const getWinnerFromFields_1 = require("../utils/getWinnerFromFields");
+(0, vitest_1.test)("getWinnerFromFields: top row all X wins", () => {
+    const fields = ["X", "X", "X", 4, 5, 6, 7, 8, 9];
+    (0, vitest_1.expect)((0, getWinnerFromFields_1.getWinnerFromFields)(fields)).toBe("X");
+});
+(0, vitest_1.test)("getWinnerFromFields: middle column all O wins", () => {
+    const fields = [1, "O", 3, 4, "O", 6, 7, "O", 9];
+    (0, vitest_1.expect)((0, getWinnerFromFields_1.getWinnerFromFields)(fields)).toBe("O");
+});
+(0, vitest_1.test)("getWinnerFromFields: diagonal 0-4-8 wins", () => {
+    const fields = ["X", 2, 3, 4, "X", 6, 7, 8, "X"];
+    (0, vitest_1.expect)((0, getWinnerFromFields_1.getWinnerFromFields)(fields)).toBe("X");
+});
+(0, vitest_1.test)("getWinnerFromFields: fresh labels — no winner", () => {
+    const fields = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+    (0, vitest_1.expect)((0, getWinnerFromFields_1.getWinnerFromFields)(fields)).toBe(null);
+});
+(0, vitest_1.test)("getWinnerFromFields: mixed line — no winner", () => {
+    const fields = ["X", "O", "X", 4, 5, 6, 7, 8, 9];
+    (0, vitest_1.expect)((0, getWinnerFromFields_1.getWinnerFromFields)(fields)).toBe(null);
+});

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

@@ -0,0 +1,9 @@
+import type { PlayerSymbol } from "./Symbol";
+export interface IBoard {
+    /** Cell value for field **1–9** (grid label shown to the player). */
+    getFieldByNumber: (fieldNumber: number) => number | PlayerSymbol;
+    setFieldByNumber: (fieldNumber: number, symbol: PlayerSymbol) => void;
+    getFields: () => (number | PlayerSymbol)[];
+    isFull: () => boolean;
+    reset: () => void;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,21 @@
+import type { PlayerSymbol } from "./Symbol";
+type GameStatusWin = {
+    status: "win";
+    winner: PlayerSymbol;
+};
+type GameStatusDraw = {
+    status: "draw";
+};
+type GameStatusRunning = {
+    status: "running";
+};
+export type GameStatus = GameStatusWin | GameStatusDraw | GameStatusRunning;
+export interface IGame {
+    readonly gameStatus: GameStatus;
+    readonly currentPlayer: PlayerSymbol;
+    savePlayerSelection: (field: number) => void;
+    reset: () => void;
+    isFieldSelected: (field: number) => boolean;
+    getBoard: () => (number | PlayerSymbol)[];
+}
+export {};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,3 @@
+import type { DEFAULT_GAME_SYMBOLS } from "../constants";
+export type PlayerSymbols = typeof DEFAULT_GAME_SYMBOLS;
+export type PlayerSymbol = PlayerSymbols[number];

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/core/utils/getWinnerFromFields.d.ts

@@ -0,0 +1,2 @@
+/** Winner from a 9-cell row-major slice matching {@link Board} (`number` = empty slot label). */
+export declare function getWinnerFromFields<TSymbol extends string>(fields: readonly (number | TSymbol)[]): TSymbol | null;

package/dist/src/core/utils/getWinnerFromFields.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWinnerFromFields = getWinnerFromFields;
+const constants_1 = require("../constants");
+/** Winner from a 9-cell row-major slice matching {@link Board} (`number` = empty slot label). */
+function getWinnerFromFields(fields) {
+    for (const combination of constants_1.WINNING_COMBINATIONS_INDEXES) {
+        const firstIdx = combination[0];
+        const field = fields[firstIdx];
+        const isWinningCombination = combination.every((i) => fields[i] === field);
+        if (typeof field === "string" && isWinningCombination) {
+            return field;
+        }
+    }
+    return null;
+}

package/dist/src/ui/components/Header/Header.d.ts

@@ -0,0 +1 @@
+export declare const Header: () => void;

package/dist/src/ui/components/Header/Header.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Header = void 0;
+const styledLabel_1 = require("../../../ui/utils/styledLabel");
+const borderStyle = { color: "red" };
+const Header = () => {
+    console.log(`\t`);
+    const gameName = (0, styledLabel_1.styledLabel)("Tic Tac Toe Game", {
+        color: "yellow",
+        textStyle: "bold",
+    });
+    const border = (0, styledLabel_1.styledLabel)("============================================", borderStyle);
+    const sideBorder = (0, styledLabel_1.styledLabel)("|", borderStyle);
+    const headerLabel = (0, styledLabel_1.styledLabel)(`${border} 
+${sideBorder}             ${gameName}             ${sideBorder} 
+${border}`);
+    console.log(headerLabel);
+    console.log("\t");
+};
+exports.Header = Header;

package/dist/src/ui/components/Header/index.d.ts

@@ -0,0 +1 @@
+export * from "./Header";

package/dist/src/ui/components/Header/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Header"), exports);

package/dist/src/ui/components/UserInput/UserInput.d.ts

@@ -0,0 +1,2 @@
+export declare const UserInput: (query: string) => Promise<unknown>;
+export declare const closeInput: () => void;