knightstour 1.0.0 → 1.0.2

package/index.d.ts

@@ -0,0 +1,65 @@
+export interface KnightPlayer {
+    name: string;
+    color: string;
+    moveIndexes: number[];
+    CPU?: boolean; // optional, since you reference it in hint()
+}
+
+export interface KnightsTourConfig {
+    rows?: number;
+    cols?: number;
+    players?: KnightPlayer[];
+    gameMode?: string;
+    disabledIndexes?: number[];
+}
+
+export interface Cell {
+    index: number;
+    isDisabled: boolean;
+    isHighlighted: boolean;
+    isClosed: boolean;
+    value: number | null;
+}
+
+export default class KnightsTour {
+    static KNIGHT_OFFSETS: number[][];
+
+    rows: number;
+    cols: number;
+    players: KnightPlayer[];
+    gameMode: string;
+    disabledIndexes: number[];
+    initialConfig: KnightsTourConfig;
+    cells: Cell[];
+    solved: boolean;
+    generated: boolean;
+    turnIndex: number;
+    state: string;
+    matrix: Cell[][];
+    allMoveIndexes: number[];
+    solving?: boolean;
+    generating?: boolean;
+
+    constructor(config?: KnightsTourConfig);
+
+    init(config: KnightsTourConfig): void;
+    reset(): void;
+    createBoard(): void;
+    getCell(index: number): Cell | null;
+    getAvailableMovesFor(playerIndex: number): number[];
+    move(index: number): boolean;
+    undo(): void;
+    getNextMoves(startIndex: number, increment?: number): number[];
+    updateBoard(autoMove?: boolean): void;
+    clear(): void;
+    determineWinner(): string;
+    isComplete(): boolean;
+    isClosed(lastMove?: number): boolean;
+    getKnightMovesAt(index: number, context?: boolean): number[];
+    isAvailable(index: number): boolean;
+    isVisited(index: number): boolean;
+    isValid(index: number): boolean;
+    hint(): void;
+    solve(increment?: number): void;
+    generate(increment?: number): void;
+}

package/index.js

@@ -362,7 +362,7 @@ class KnightsTour {
         const c = index % this.cols;
         const moves = [];
 
-        for (const [dr, dc] of Game.KNIGHT_OFFSETS) {
+        for (const [dr, dc] of KnightsTour.KNIGHT_OFFSETS) {
             const nR = r + dr,
                 nC = c + dc;
             const nIdx = nR * this.cols + nC;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "knightstour",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "index.js",
+  "types": "index.d.ts",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"