@johnmorrisdotca/jirai 0.1.0 → 0.2.1

package/src/orthogonal.ts

@@ -0,0 +1,50 @@
+import { deduce } from "./deduce.ts";
+import { newGame, visibleGame } from "./game.ts";
+import { makeBoard } from "./generate.ts";
+import { neighbours, validSettings } from "./grid.ts";
+import { gameFromProgress, gameProgress } from "./keep.ts";
+import type { Board, GenerationOptions, Game, Settings } from "./jirai.types.ts";
+
+/** Identifies the four-neighbour rules and progress-code format. */
+export const ORTHOGONAL_VARIANT = "orthogonal" as const;
+/** Settings accepted by the four-neighbour-specific helpers. */
+export type OrthogonalSettings = Omit<Settings, "grid">;
+
+/** Starts a game under four-neighbour rules. */
+export function newOrthogonalGame(settings: OrthogonalSettings): Game {
+  return newGame({ ...settings, grid: ORTHOGONAL_VARIANT });
+}
+
+/** Deals a board whose clues count only up, down, left and right. */
+export function makeOrthogonalBoard(
+  settings: OrthogonalSettings,
+  first: number,
+  options?: GenerationOptions,
+): Board {
+  return makeBoard({ ...settings, grid: ORTHOGONAL_VARIANT }, first, options);
+}
+
+/** Returns the adjacent cells under the orthogonal rules. */
+export function orthogonalNeighbours(settings: OrthogonalSettings, cell: number): number[] {
+  const complete = { ...settings, grid: ORTHOGONAL_VARIANT } as Settings;
+  if (!validSettings(complete)) throw new RangeError("Invalid orthogonal settings.");
+  return neighbours(complete, cell);
+}
+
+/** Gives a clue-only deduction; flags remain notes and cannot influence the result. */
+export function orthogonalHint(game: Game) {
+  if (game.settings.grid !== ORTHOGONAL_VARIANT) throw new RangeError("Expected an orthogonal game.");
+  return deduce(visibleGame(game));
+}
+
+/** Encodes an orthogonal game with an explicit variant marker and version 2. */
+export function encodeOrthogonalGame(game: Game): string {
+  if (game.settings.grid !== ORTHOGONAL_VARIANT) throw new RangeError("Expected an orthogonal game.");
+  return gameProgress(game);
+}
+
+/** Restores only version 2 orthogonal progress records. */
+export function decodeOrthogonalGame(code: string): Game | null {
+  const game = gameFromProgress(code);
+  return game?.settings.grid === ORTHOGONAL_VARIANT ? game : null;
+}

package/src/react.tsx

@@ -2,7 +2,7 @@ import { useEffect, useRef } from "react";
 import { mountJirai } from "./mount.ts";
 import type { JiraiProps } from "./react.types.ts";
 
-/** The plain-DOM game as a React component. Options are read on mount; give it a new key to load a new board. */
+/** Renders the DOM player inside a React-owned host. Options are read on mount; use a new key to load a new board. */
 export function JiraiBoard({ settings, progress, material, pieces, language, controls, onChange, onFinish, onError, ...element }: JiraiProps) {
   const host = useRef<HTMLDivElement>(null);
   const latest = useRef({ onChange, onFinish, onError });

package/src/react.types.ts

@@ -1,3 +1,4 @@
 import type { HTMLAttributes } from "react";
 import type { MountOptions } from "./ui.types.ts";
+/** Mount options plus standard div attributes for the React wrapper. */
 export type JiraiProps = MountOptions & Omit<HTMLAttributes<HTMLDivElement>, "onChange" | "onError">;

package/src/shape.ts

@@ -1,4 +1,5 @@
 import type { Settings } from "./jirai.types.ts";
+/** Board silhouettes supported by settings. */
 export const SHAPES = ["rectangle", "heart", "star", "hexagon"] as const;
 /** Row-major addresses stay stable; omitted cells have no clue and no neighbours. */
 export function activeCell(settings: Settings, cell: number): boolean {
@@ -27,6 +28,7 @@ export function activeCell(settings: Settings, cell: number): boolean {
     default: return true;
   }
 }
+/** Returns all active cells in stable row-major order. */
 export function activeCells(settings: Settings): number[] {
   return Array.from({ length: settings.width * settings.height }, (_, cell) => cell).filter(cell => activeCell(settings, cell));
 }

package/src/strings.ts

@@ -1,4 +1,5 @@
 import type { Language } from "./jirai.types.ts";
+/** Built-in English and Japanese strings used by the player and renderer. */
 export const STRINGS = {
   en: {
     board: "Minesweeper board", covered: "covered", flag: "flagged", question: "uncertain", empty: "empty", mine: "mine", wrong: "incorrect flag",
@@ -15,4 +16,5 @@ export const STRINGS = {
     error: "推測なしで解ける盤が見つかりませんでした。別のシード、別の開始マス、または少ない地雷で試してください。",
   },
 } as const;
+/** Returns the built-in interface strings for a locale. */
 export function words(language: Language = "en"): typeof STRINGS["en"] | typeof STRINGS["ja"] { return STRINGS[language]; }

package/src/ui.types.ts

@@ -1,7 +1,11 @@
 import type { Game, Language, Material, Pieces, Settings } from "./jirai.types.ts";
+/** Appearance and optional hint marker used by drawing and play. */
 export type DrawOptions = { material?: Material; pieces?: Pieces; language?: Language; hint?: number | null };
+/** Accessible presentation data for one active board cell. */
 export type CellModel = { cell: number; x: number; y: number; width: number; height: number; label: string; text: string; kind: string; hint: boolean };
+/** Layout and cell presentation returned by `boardModel`. */
 export type BoardModel = { width: number; height: number; cells: CellModel[] };
+/** Initial game, appearance, control, and lifecycle callbacks for a mounted board. */
 export type MountOptions = DrawOptions & {
   settings?: Settings;
   progress?: string;
@@ -10,6 +14,7 @@ export type MountOptions = DrawOptions & {
   onFinish?: (game: Game) => void;
   onError?: (error: Error) => void;
 };
+/** Controls for reading and operating a mounted board. */
 export type JiraiMount = {
   game: () => Game;
   progress: () => string;

package/src/deduce.test.ts

@@ -1,47 +0,0 @@
-import { expect, it } from "vitest";
-import { deduce, hintFor } from "./deduce.ts";
-import { enumerateForced } from "./enumerate.ts";
-import { DEFAULT_SETTINGS, MARKS, STATUSES } from "./jirai.constants.ts";
-import { neighbours } from "./grid.ts";
-import type { VisibleGame, Grid } from "./jirai.types.ts";
-
-it("extracts the 1–2–1 wall pattern without trusting flags", () => {
-  const game: VisibleGame = {
-    settings: { ...DEFAULT_SETTINGS, width: 3, height: 3, mines: 2 }, status: STATUSES.playing,
-    clues: [null,null,null,1,2,1,0,0,0], marks: [MARKS.flag,MARKS.flag,MARKS.covered,...Array(6).fill(MARKS.open)],
-  };
-  const hint = hintFor(game);
-  expect(hint.safe).toContain(1); // A wrongly flagged square is still provably safe.
-});
-
-it("enumeration proves only cells forced in every consistent assignment", () => {
-  const proof = enumerateForced([
-    { cells: [0,1], mines: 1, sources: [3] },
-    { cells: [1,2], mines: 1, sources: [4] },
-    { cells: [0,2], mines: 0, sources: [5] },
-  ]);
-  expect([...proof.safe].sort()).toEqual([0,2]); expect(proof.mines).toEqual([1]);
-  expect(enumerateForced([{ cells: [0,1], mines: 1, sources: [] }]).safe).toEqual([]);
-  expect(enumerateForced([{ cells: [0], mines: 2, sources: [] }]).contradiction).toBe(true);
-});
-
-it("agrees with an independent exhaustive oracle on square, hex and wrapped 3×3 positions", () => {
-  for (const grid of ["square", "hex", "wrap"] as Grid[]) {
-    const settings = { ...DEFAULT_SETTINGS, width: 3, height: 3, mines: 2, grid };
-    for (let firstMine = 0; firstMine < 9; firstMine += 1) for (let secondMine = firstMine + 1; secondMine < 9; secondMine += 1) {
-      const actual = [firstMine, secondMine];
-      const clues = Array.from({ length: 9 }, (_, cell) => !actual.includes(cell) && cell % 2 === 0 ? neighbours(settings, cell).filter((n) => actual.includes(n)).length : null);
-      const possible: number[][] = [];
-      for (let a = 0; a < 9; a += 1) for (let b = a + 1; b < 9; b += 1) {
-        const mines = [a,b];
-        if (mines.some((cell) => clues[cell] !== null)) continue;
-        if (clues.every((clue, cell) => clue === null || neighbours(settings, cell).filter((n) => mines.includes(n)).length === clue)) possible.push(mines);
-      }
-      const game: VisibleGame = { settings, clues, status: STATUSES.playing, marks: clues.map((n) => n === null ? MARKS.flag : MARKS.open) };
-      const result = deduce(game);
-      expect(result.contradiction).toBe(false); expect(possible.length).toBeGreaterThan(0);
-      for (const cell of result.safe) expect(possible.every((mines) => !mines.includes(cell))).toBe(true);
-      for (const cell of result.mines) expect(possible.every((mines) => mines.includes(cell))).toBe(true);
-    }
-  }
-});

package/src/game.test.ts

@@ -1,129 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { newGame, play, visibleGame } from "./game.ts";
-import { makeBoard, isSolvable, GenerationError } from "./generate.ts";
-import { DEFAULT_SETTINGS, GRIDS, MARKS, MOVES, STATUSES } from "./jirai.constants.ts";
-import { neighbours, neighboursOf, validSettings } from "./grid.ts";
-import { gameFromProgress, gameProgress, dailySeed } from "./keep.ts";
-import { boardModel } from "./draw.ts";
-import type { Board, Game, Settings } from "./jirai.types.ts";
-
-function fixedGame(minesAt: number[]): Game {
-  const settings: Settings = { ...DEFAULT_SETTINGS, width: 5, height: 5, mines: minesAt.length, noGuess: false, opening: "safe" };
-  const mines = Array.from({ length: 25 }, (_, cell) => minesAt.includes(cell));
-  const clues = mines.map((mine, cell) => mine ? -1 : neighbours(settings, cell).filter((n) => mines[n]).length);
-  const board: Board = { settings, mines, clues, first: 12, attempt: 0 };
-  return { ...newGame(settings), board };
-}
-
-describe("the three boards", () => {
-  for (const grid of Object.values(GRIDS)) it(`${grid} has reciprocal, unique neighbours and no self-neighbours`, () => {
-    const settings = { ...DEFAULT_SETTINGS, width: 7, height: 5, grid };
-    const all = neighboursOf(settings);
-    for (let cell = 0; cell < all.length; cell += 1) {
-      expect(new Set(all[cell]).size).toBe(all[cell]!.length);
-      expect(all[cell]).not.toContain(cell);
-      for (const n of all[cell]!) expect(all[n]).toContain(cell);
-    }
-  });
-  it("uses six hex neighbours, eight square neighbours, and joins both wrap seams", () => {
-    expect(neighbours({ ...DEFAULT_SETTINGS, grid: GRIDS.hex }, 40)).toHaveLength(6);
-    expect(neighbours(DEFAULT_SETTINGS, 40)).toHaveLength(8);
-    expect(neighbours({ ...DEFAULT_SETTINGS, grid: GRIDS.wrap }, 0)).toEqual([1,8,9,10,17,72,73,80]);
-  });
-  it("rejects malformed or excessive settings before making a board", () => {
-    for (const change of [{ width: 1 }, { width: 61 }, { width: 60, height: 60 }, { mines: 81 }, { seed: NaN }, { grid: "__proto__" }, { mines: 1.5 }, { noGuess: "yes" }]) expect(validSettings({ ...DEFAULT_SETTINGS, ...change })).toBe(false);
-  });
-});
-
-describe("dealing and verified boards", () => {
-  for (const grid of Object.values(GRIDS)) it(`${grid} deals exact counts and a clear first opening for many seeds`, () => {
-    for (let seed = 0; seed < 40; seed += 1) {
-      const settings = { ...DEFAULT_SETTINGS, grid, seed, noGuess: false };
-      const board = makeBoard(settings, 40);
-      expect(board.mines.filter(Boolean)).toHaveLength(10);
-      expect(board.clues[40]).toBe(0);
-      for (let cell = 0; cell < 81; cell += 1) {
-        expect(board.clues[cell]).toBe(board.mines[cell] ? -1 : neighbours(settings, cell).filter((n) => board.mines[n]).length);
-      }
-      expect(makeBoard(settings, 40)).toEqual(board);
-    }
-  });
-  for (const grid of Object.values(GRIDS)) it(`${grid} only advertises boards its visible-clue solver actually finishes`, () => {
-    for (let seed = 0; seed < 15; seed += 1) expect(isSolvable(makeBoard({ ...DEFAULT_SETTINGS, grid, seed }, 40))).toBe(true);
-  });
-  it("reports a failed proof budget rather than returning an unverified board", () => {
-    let failures = 0;
-    for (let seed = 0; seed < 50; seed += 1) {
-      try { makeBoard({ ...DEFAULT_SETTINGS, width: 5, height: 5, mines: 10, opening: "safe", seed }, 12, { attempts: 1 }); }
-      catch (error) { expect(error).toBeInstanceOf(GenerationError); expect((error as GenerationError).code).toBe("exhausted"); failures += 1; }
-    }
-    expect(failures).toBeGreaterThan(0);
-  });
-  it("rejects a dense board that cannot protect the chosen opening", () => {
-    expect(() => makeBoard({ ...DEFAULT_SETTINGS, width: 3, height: 3, mines: 1 }, 4)).toThrow(GenerationError);
-  });
-});
-
-describe("moves", () => {
-  it("floods empty ground and wins without requiring any flags", () => {
-    const game = fixedGame([0]);
-    const before = structuredClone(game);
-    const next = play(game, { kind: MOVES.reveal, cell: 24 });
-    expect(next.status).toBe(STATUSES.won);
-    expect(next.marks.filter((mark) => mark === MARKS.open)).toHaveLength(24);
-    expect(game).toEqual(before);
-  });
-  it("does not open a flagged cell, including inside a flood", () => {
-    let game = fixedGame([0]);
-    game = play(game, { kind: MOVES.mark, cell: 24 });
-    expect(play(game, { kind: MOVES.reveal, cell: 24 })).toBe(game);
-    game = play(game, { kind: MOVES.reveal, cell: 20 });
-    expect(game.marks[24]).toBe(MARKS.flag);
-    expect(game.status).toBe(STATUSES.playing);
-  });
-  it("cycles notes through flag, question and covered", () => {
-    let game = newGame();
-    for (const mark of [MARKS.flag, MARKS.question, MARKS.covered]) { game = play(game, { kind: MOVES.mark, cell: 0 }); expect(game.marks[0]).toBe(mark); }
-    expect(game.board).toBeNull();
-  });
-  it("chords a matched number and loses if the flags were wrong", () => {
-    let game = fixedGame([0,24]);
-    game = play(game, { kind: MOVES.reveal, cell: 6 });
-    expect(play(game, { kind: MOVES.chord, cell: 6 })).toBe(game);
-    game = play(game, { kind: MOVES.mark, cell: 1 });
-    game = play(game, { kind: MOVES.chord, cell: 6 });
-    expect(game.status).toBe(STATUSES.lost); expect(game.exploded).toBe(0);
-    expect(play(game, { kind: MOVES.mark, cell: 3 })).toBe(game);
-  });
-  it("chords correctly flagged mines without revealing them", () => {
-    let game = fixedGame([0,24]);
-    game = play(game, { kind: MOVES.reveal, cell: 6 });
-    game = play(game, { kind: MOVES.mark, cell: 0 });
-    game = play(game, { kind: MOVES.chord, cell: 6 });
-    expect(game.status).not.toBe(STATUSES.lost); expect(game.marks[0]).toBe(MARKS.flag);
-  });
-  it("keeps hidden answers out of both the clue view and drawing", () => {
-    const game = fixedGame([0,24]);
-    expect(visibleGame(game).clues.every((clue) => clue === null)).toBe(true);
-    expect(boardModel(game).cells.every((cell) => cell.text === "" && cell.kind === MARKS.covered)).toBe(true);
-  });
-  it("replays a saved game from its seed and moves; malformed records are refused", () => {
-    let game = newGame({ ...DEFAULT_SETTINGS, noGuess: false });
-    game = play(game, { kind: MOVES.mark, cell: 0 }); game = play(game, { kind: MOVES.reveal, cell: 40 });
-    expect(gameFromProgress(gameProgress(game))).toEqual(game);
-    for (const data of ["garbage", "null", '{"version":2}', JSON.stringify({ version: 1, settings: DEFAULT_SETTINGS, moves: [{ kind: "reveal", cell: -1 }] })]) expect(gameFromProgress(data)).toBeNull();
-  });
-  it("has stable daily seeds and rejects impossible calendar dates", () => {
-    expect(dailySeed("2026-10-04")).toBe(dailySeed("2026-10-04"));
-    expect(dailySeed("2026-10-04", "hex")).not.toBe(dailySeed("2026-10-04"));
-    expect(() => dailySeed("2026-02-30")).toThrow();
-  });
-});
-
-export { fixedGame };
-
-it("keeps assisted status through public progress and rejects invalid assisted data", () => {
-  const game = { ...newGame(), helped: true };
-  expect(gameFromProgress(gameProgress(game))?.helped).toBe(true);
-  expect(gameFromProgress(JSON.stringify({ version: 1, settings: game.settings, moves: [], helped: "yes" }))).toBeNull();
-});

package/src/shape.test.ts

@@ -1,56 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { activeCell, activeCells } from "./shape.ts";
-import { DEFAULT_SETTINGS, GRIDS } from "./jirai.constants.ts";
-import { neighboursOf, validSettings } from "./grid.ts";
-import { makeBoard, isSolvable } from "./generate.ts";
-import { newGame, play, visibleGame } from "./game.ts";
-import { boardModel } from "./draw.ts";
-import { gameFromProgress, gameProgress } from "./keep.ts";
-import type { Settings } from "./jirai.types.ts";
-
-describe("shaped minefields", () => {
-  for (const shape of ["heart", "star", "hexagon"] as const) for (const grid of [GRIDS.square, GRIDS.hex]) {
-    it(`${shape}/${grid} omits cells and retains reciprocal neighbours and proved deals`, () => {
-      const settings: Settings = { ...DEFAULT_SETTINGS, width: 17, height: 17, mines: 12, shape, grid };
-      for (const outside of [-1, 289, 1.5, NaN]) expect(activeCell(settings, outside)).toBe(false);
-      const cells = activeCells(settings), adjacent = neighboursOf(settings);
-      expect(cells.length).toBeGreaterThan(40); expect(cells.length).toBeLessThan(289);
-      for (const c of cells) for (const n of adjacent[c]!) {
-        expect(activeCell(settings, n)).toBe(true); expect(adjacent[n]).toContain(c);
-      }
-      const first = cells[Math.floor(cells.length / 2)]!;
-      for (let seed = 1; seed <= 12; seed += 1) {
-        const board = makeBoard({ ...settings, seed }, first);
-        expect(board.mines.filter(Boolean)).toHaveLength(12); expect(isSolvable(board)).toBe(true);
-        for (let c = 0; c < 289; c += 1) if (!activeCell(settings, c)) {
-          expect(board.mines[c]).toBe(false); expect(board.clues[c]).toBe(-2); expect(adjacent[c]).toEqual([]);
-        }
-      }
-    });
-  }
-  it("never draws or lets the player act on cut-out cells, and restores the shape", () => {
-    const settings: Settings = { ...DEFAULT_SETTINGS, width: 17, height: 17, shape: "heart", mines: 12 };
-    let game = newGame(settings);
-    const absent = Array.from({ length: 289 }, (_, c) => c).find(c => !activeCell(settings, c))!;
-    expect(play(game, { kind: "reveal", cell: absent })).toBe(game);
-    expect(play(game, { kind: "mark", cell: absent })).toBe(game);
-    expect(visibleGame(game).clues[absent]).toBe(-2);
-    expect(boardModel(game).cells.some(c => c.cell === absent)).toBe(false);
-    game = play(game, { kind: "reveal", cell: activeCells(settings)[50]! });
-    expect(gameFromProgress(gameProgress(game))?.settings.shape).toBe("heart");
-  });
-  it("wins when every active safe cell opens, without requiring absent cells", () => {
-    const settings: Settings = { ...DEFAULT_SETTINGS, width: 9, height: 9, shape: "star", mines: 1, noGuess: false };
-    let game = newGame(settings);
-    const first = activeCells(settings)[10]!;
-    game = play(game, { kind: "reveal", cell: first });
-    for (const c of activeCells(settings)) if (!game.board!.mines[c]) game = play(game, { kind: "reveal", cell: c });
-    expect(game.status).toBe("won");
-  });
-  it("rejects unknown outlines, tiny silhouettes, wrap cut-outs and excess mines", () => {
-    expect(validSettings({ ...DEFAULT_SETTINGS, shape: "toString" })).toBe(false);
-    expect(validSettings({ ...DEFAULT_SETTINGS, width: 5, height: 5, shape: "heart" })).toBe(false);
-    expect(validSettings({ ...DEFAULT_SETTINGS, shape: "heart", grid: "wrap" })).toBe(false);
-    expect(validSettings({ ...DEFAULT_SETTINGS, width: 9, height: 9, shape: "star", mines: 70 })).toBe(false);
-  });
-});