mons-rules 0.3.4 → 0.4.0

package/README.md

@@ -1,8 +1,7 @@
 # Mons rules engine
 
-`mons-rules` is the dependency-free TypeScript rules engine for Super Metal
-Mons. It is an ESM-only package for browsers, Web Workers, Node.js, and Firebase
-Cloud Functions.
+Dependency-free TypeScript rules for Super Metal Mons. The ESM-only package
+runs in browsers, Web Workers, Node.js, and Firebase Cloud Functions.
 
 ## Install
 
@@ -13,7 +12,7 @@ npm install mons-rules
 ## Use
 
 ```ts
-import { AutomovePreference, Game, GameVariant, type Input } from "mons-rules";
+import { Game, GameVariant, type Input } from "mons-rules";
 
 const game = new Game({ variant: GameVariant.Classic });
 const inputs: Input[] = [
@@ -21,12 +20,12 @@ const inputs: Input[] = [
   { kind: "position", position: { row: 9, column: 4 } },
 ];
 const result = game.play(inputs);
-const suggestion = game.suggestMove(AutomovePreference.Pro);
+const suggestion = game.suggestMove("pro");
 ```
 
-Use `preview` or `previewFen` to inspect inputs without mutating the game. Use
-`play` or `playFen` to apply a complete legal move. Serialize games with
-`toFen` and restore them with `Game.fromFen`.
+Use `preview` to inspect typed inputs without mutation. Use `play` or `playFen`
+to apply a complete legal move. Serialize with `toFen` and restore with
+`Game.fromFen`.
 
 Published JavaScript targets ES2020 and uses Web-standard `performance` and
 `crypto` globals. Node.js 22.13 through 22.x, or Node.js 24 or newer, is

package/dist/api/game.d.ts

@@ -1,8 +1,9 @@
-import { type AvailableMoveCounts, type AutomovePreference as AutomovePreferenceValue, type BoardItem, type Color as ColorValue, type GameVariant as GameVariantValue, type Input, type InputResolution, type MoveSuggestion, type MoveUsage, type PlayResult, type Position, type Square, type TrackingEntry } from "./types.js";
-export type GameOptions = {
+import { type AvailableMoveCounts, type BoardItem, type Color as ColorValue, type GameVariant as GameVariantValue, type Input, type InputResolution, type MoveSuggestion, type PlayResult, type Position, type Square, type TrackingEntry } from "./types.js";
+type StrategicPreference = "fast" | "normal" | "pro";
+type GameOptions = {
     readonly variant?: GameVariantValue;
 };
-export type MoveHistory = {
+type MoveHistory = {
     readonly white: readonly string[];
     readonly black: readonly string[];
 };
@@ -15,14 +16,12 @@ export declare class Game {
     get turnNumber(): number;
     get scores(): Readonly<Record<ColorValue, number>>;
     get potions(): Readonly<Record<ColorValue, number>>;
-    get moveUsage(): MoveUsage;
     get winner(): ColorValue | undefined;
     get historyVerified(): boolean;
     get takebackFens(): readonly string[];
     get trackingEntries(): readonly TrackingEntry[];
     toFen(): string;
     preview(inputs: readonly Input[]): InputResolution;
-    previewFen(inputFen: string): InputResolution;
     play(inputs: readonly Input[]): PlayResult;
     playFen(inputFen: string): PlayResult;
     itemAt(position: Position): BoardItem | undefined;
@@ -34,6 +33,6 @@ export declare class Game {
     verifyHistory(history: MoveHistory): boolean;
     isLaterThan(other: Game): boolean;
     availableMoveCounts(): AvailableMoveCounts;
-    suggestMove(preference: AutomovePreferenceValue): MoveSuggestion | undefined;
-    clearTracking(): void;
+    suggestMove(preference: StrategicPreference): MoveSuggestion | undefined;
 }
+export {};

package/dist/api/types.d.ts

@@ -37,13 +37,6 @@ export declare const Modifier: Readonly<{
     readonly SelectBomb: "select-bomb";
 }>;
 export type Modifier = (typeof Modifier)[keyof typeof Modifier];
-export declare const AutomovePreference: Readonly<{
-    readonly Random: "random";
-    readonly Fast: "fast";
-    readonly Normal: "normal";
-    readonly Pro: "pro";
-}>;
-export type AutomovePreference = (typeof AutomovePreference)[keyof typeof AutomovePreference];
 export type Position = {
     readonly row: number;
     readonly column: number;
@@ -59,7 +52,7 @@ export type Mana = {
 } | {
     readonly kind: "supermana";
 };
-export type Carryable = {
+type Carryable = {
     readonly kind: "mana";
     readonly mana: Mana;
 } | {
@@ -200,11 +193,11 @@ export type GameEvent = {
 } | {
     readonly kind: "takeback";
 };
-export type InvalidInputResolution = {
+type InvalidInputResolution = {
     readonly kind: "invalid";
     readonly inputFen: string;
 };
-export type CompleteInputResolution = {
+type CompleteInputResolution = {
     readonly kind: "complete";
     readonly inputFen: string;
     readonly events: readonly GameEvent[];
@@ -219,12 +212,10 @@ export type InputResolution = InvalidInputResolution | {
     readonly options: readonly InputOption[];
 } | CompleteInputResolution;
 export type PlayResult = InvalidInputResolution | CompleteInputResolution;
-export type MoveUsage = {
+export type AvailableMoveCounts = {
     readonly monMoves: number;
     readonly manaMoves: number;
     readonly actions: number;
-};
-export type AvailableMoveCounts = MoveUsage & {
     readonly potions: number;
 };
 export type TrackingEntry = {
@@ -238,7 +229,7 @@ export type MoveSuggestion = {
     readonly inputFen: string;
     readonly events: readonly GameEvent[];
 };
-export type PlayerSubmission = {
+type PlayerSubmission = {
     readonly fen: string;
     readonly moves: readonly string[];
 };

package/dist/entrypoints/mons-rules.d.ts

@@ -1,5 +1,4 @@
 export { Game } from "../api/game.js";
-export type { GameOptions, MoveHistory } from "../api/game.js";
 export { resolveMatch } from "../api/winner.js";
-export { AutomovePreference, Color, Consumable, GameVariant, Modifier, MonKind, } from "../api/types.js";
-export type { AvailableMoveCounts, BoardItem, Carryable, CompleteInputResolution, GameEvent, Input, InputAction, InputOption, InputResolution, InvalidInputResolution, Mana, MatchResolution, MatchSubmission, Mon, MoveSuggestion, MoveUsage, PlayerSubmission, PlayResult, Position, Square, TrackingEntry, } from "../api/types.js";
+export { Color, Consumable, GameVariant, Modifier, MonKind, } from "../api/types.js";
+export type { AvailableMoveCounts, BoardItem, GameEvent, Input, InputResolution, Mana, Mon, Position, Square, } from "../api/types.js";