gigaboard 1.4.1 → 1.5.0

package/dist/index.d.cts

@@ -1,12 +1,55 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as ChessboardProps, T as Theme, O as Orientation, A as AnimationOptions, R as ResolvedArrowPalette, U as UseChessGameOptions, P as PieceRenderer } from './types-DfqRXtbD.cjs';
-export { a as ArrowColors, D as DEFAULT_MOVE_HAPTIC_PATTERNS, b as DEFAULT_MOVE_SOUND_SOURCES, H as HapticFeedbackOptions, L as LegalTargetStyle, M as MoveFeedbackKey, c as MoveHapticKey, d as MoveHapticOptions, e as MoveHapticPatterns, f as MoveSoundKey, g as MoveSoundOptions, h as MoveSoundSources, i as PositionTransition, j as PromotionContext, k as RanksPosition, S as SquareContext, l as TriggerMoveHaptic, m as TriggerMoveSound, n as classifyMoveFeedback, t as triggerHaptic, o as triggerMoveHaptic, u as useMoveHaptics, p as useMoveSound, w as warmupHaptics } from './types-DfqRXtbD.cjs';
-export { c as createGigachessAdapter, p as preloadGigachessAdapter } from './gigachess-Dr5gCN68.cjs';
-import { v as BoardModel, x as BoardSnapshot, S as SquareIndex, w as BoardModelOptions, P as PackedMove, u as BoardCell } from './board-model-BMtkLQvL.cjs';
-export { D as Color, E as EngineAdapter, a as PieceType, Z as ZobristKey, _ as createBoardModel, a5 as packMove, a7 as unpackMove } from './board-model-BMtkLQvL.cjs';
-import { RefObject, ReactNode } from 'react';
+import { CSSProperties, RefObject, ReactNode } from 'react';
+import { S as SquareIndex, u as BoardCell, v as BoardModel, x as BoardSnapshot, w as BoardModelOptions, P as PackedMove } from './board-model-BIVxSCWC.cjs';
+export { D as Color, E as EngineAdapter, W as NULL_MOVE_SAN, X as NULL_MOVE_SANS, Y as NULL_MOVE_UCI, Z as NULL_MOVE_WORD, a as PieceType, a1 as ZobristKey, a2 as createBoardModel, a8 as isNullMove, a9 as isNullMoveSan, aa as isNullMoveUci, ac as packMove, ae as unpackMove } from './board-model-BIVxSCWC.cjs';
+import { O as Orientation, T as Theme, P as PieceRenderer, C as ChessboardProps, A as AnimationOptions, R as ResolvedArrowPalette, U as UseChessGameOptions } from './types-Dox7oLof.cjs';
+export { a as ArrowColors, D as DEFAULT_MOVE_HAPTIC_PATTERNS, b as DEFAULT_MOVE_SOUND_SOURCES, H as HapticFeedbackOptions, L as LegalTargetStyle, M as MoveFeedbackKey, c as MoveHapticKey, d as MoveHapticOptions, e as MoveHapticPatterns, f as MoveSoundKey, g as MoveSoundOptions, h as MoveSoundSources, i as PositionTransition, j as PromotionContext, k as RanksPosition, S as SquareContext, l as TriggerMoveHaptic, m as TriggerMoveSound, n as classifyMoveFeedback, t as triggerHaptic, o as triggerMoveHaptic, u as useMoveHaptics, p as useMoveSound, w as warmupHaptics } from './types-Dox7oLof.cjs';
+export { c as createGigachessAdapter, p as preloadGigachessAdapter } from './gigachess-XpNGPM2m.cjs';
 export { HapticInput, TriggerOptions } from 'web-haptics';
 
+declare function formatFenPlacement(board: Uint8Array): string;
+interface BoardEditorProps {
+    /** Current FEN or placement string. */
+    fen?: string;
+    /** Called whenever the board placement changes. */
+    onChange?: (fen: string) => void;
+    /** Called when a specific square piece changes. */
+    onPieceChange?: (square: SquareIndex, cell: BoardCell, algebraic: string) => void;
+    /** Currently selected piece for placement (e.g. "wP", "bP", "wK", or null for eraser). */
+    selectedPiece?: string | null;
+    /** Callback when shortcut piece is chosen. */
+    onSelectPiece?: (piece: string | null) => void;
+    /** Board orientation (default "white"). */
+    orientation?: Orientation;
+    /** Board visual theme. */
+    theme?: Theme;
+    /** Piece renderer. */
+    pieces?: PieceRenderer;
+    /** Whether algebraic coordinates are shown. */
+    showCoordinates?: boolean;
+    /** Container style overrides. */
+    style?: CSSProperties;
+    /** Container class name. */
+    className?: string;
+    /** Accessible label. */
+    ariaLabel?: string;
+    /** Announce feedback callback (e.g. forward to useAriaLive). */
+    onAnnounce?: (message: string) => void;
+    /** Custom generator for square speech labels. */
+    getSquareAriaLabel?: (square: SquareIndex, cell: BoardCell, algebraic: string) => string;
+    /** Current focused square (controlled). */
+    focusedSquare?: SquareIndex;
+    /** Square focus callback. */
+    onSquareFocus?: (square: SquareIndex, cell: BoardCell, algebraic: string) => void;
+    /** Clear board callback. */
+    onClear?: () => void;
+    /** Set starting position callback. */
+    onSetStartingPosition?: () => void;
+    /** Toggle side to move callback. */
+    onToggleSideToMove?: () => void;
+}
+declare function BoardEditor({ fen, onChange, onPieceChange, selectedPiece, onSelectPiece, orientation, theme, pieces, showCoordinates, style, className, ariaLabel, onAnnounce, getSquareAriaLabel, focusedSquare: propFocusedSquare, onSquareFocus, onClear, onSetStartingPosition, onToggleSideToMove, }: BoardEditorProps): react_jsx_runtime.JSX.Element;
+
 /**
  * Interactive chess board.
  *
@@ -423,6 +466,10 @@ declare function getPointAtSquareCentre(container: HTMLElement, square: SquareIn
     readonly x: number;
     readonly y: number;
 };
+/** Algebraic name (`"a1"`, `"h8"`, …) for a square index. */
+declare function algebraicOf(square: SquareIndex): string;
+/** Square index for an algebraic name (`"a1"`, `"h8"`, …), or `null` if invalid. */
+declare function squareOf(algebraic: string): SquareIndex | null;
 
 declare const defaultPieces: PieceRenderer;
 
@@ -436,6 +483,6 @@ declare const defaultPieces: PieceRenderer;
  */
 
 /** Package version — keep in sync with `package.json`. */
-declare const PACKAGE_VERSION = "1.3.3";
+declare const PACKAGE_VERSION = "1.5.0";
 
-export { AnimationOptions, AnimationRunner, BoardCell, BoardModel, BoardSnapshot, CSS_VARS, Chessboard, ChessboardProps, DEFAULT_ILLEGAL_FLASH_TINT, DEFAULT_PREMOVE_TINT, type HoverSquareContext, Orientation, PACKAGE_VERSION, PackedMove, PieceRenderer, ResolvedArrowPalette, SquareIndex, Theme, UseChessGameOptions, defaultArrowColors, defaultPieces, defaultTheme, getPointAtSquareCentre, getSquareAtPoint, useArrowGesture, useBoardSlice, useBoardSnapshot, useChessGame, useClickToMove, useDrag, useHoverSquare, useKeyboardNav, useSquareCell };
+export { AnimationOptions, AnimationRunner, BoardCell, BoardEditor, type BoardEditorProps, BoardModel, BoardSnapshot, CSS_VARS, Chessboard, ChessboardProps, DEFAULT_ILLEGAL_FLASH_TINT, DEFAULT_PREMOVE_TINT, type HoverSquareContext, Orientation, PACKAGE_VERSION, PackedMove, PieceRenderer, ResolvedArrowPalette, SquareIndex, Theme, UseChessGameOptions, algebraicOf, defaultArrowColors, defaultPieces, defaultTheme, formatFenPlacement, getPointAtSquareCentre, getSquareAtPoint, squareOf, useArrowGesture, useBoardSlice, useBoardSnapshot, useChessGame, useClickToMove, useDrag, useHoverSquare, useKeyboardNav, useSquareCell };

package/dist/index.d.ts

@@ -1,12 +1,55 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as ChessboardProps, T as Theme, O as Orientation, A as AnimationOptions, R as ResolvedArrowPalette, U as UseChessGameOptions, P as PieceRenderer } from './types-CcOgT5ov.js';
-export { a as ArrowColors, D as DEFAULT_MOVE_HAPTIC_PATTERNS, b as DEFAULT_MOVE_SOUND_SOURCES, H as HapticFeedbackOptions, L as LegalTargetStyle, M as MoveFeedbackKey, c as MoveHapticKey, d as MoveHapticOptions, e as MoveHapticPatterns, f as MoveSoundKey, g as MoveSoundOptions, h as MoveSoundSources, i as PositionTransition, j as PromotionContext, k as RanksPosition, S as SquareContext, l as TriggerMoveHaptic, m as TriggerMoveSound, n as classifyMoveFeedback, t as triggerHaptic, o as triggerMoveHaptic, u as useMoveHaptics, p as useMoveSound, w as warmupHaptics } from './types-CcOgT5ov.js';
-export { c as createGigachessAdapter, p as preloadGigachessAdapter } from './gigachess-C08uAeFw.js';
-import { v as BoardModel, x as BoardSnapshot, S as SquareIndex, w as BoardModelOptions, P as PackedMove, u as BoardCell } from './board-model-BMtkLQvL.js';
-export { D as Color, E as EngineAdapter, a as PieceType, Z as ZobristKey, _ as createBoardModel, a5 as packMove, a7 as unpackMove } from './board-model-BMtkLQvL.js';
-import { RefObject, ReactNode } from 'react';
+import { CSSProperties, RefObject, ReactNode } from 'react';
+import { S as SquareIndex, u as BoardCell, v as BoardModel, x as BoardSnapshot, w as BoardModelOptions, P as PackedMove } from './board-model-BIVxSCWC.js';
+export { D as Color, E as EngineAdapter, W as NULL_MOVE_SAN, X as NULL_MOVE_SANS, Y as NULL_MOVE_UCI, Z as NULL_MOVE_WORD, a as PieceType, a1 as ZobristKey, a2 as createBoardModel, a8 as isNullMove, a9 as isNullMoveSan, aa as isNullMoveUci, ac as packMove, ae as unpackMove } from './board-model-BIVxSCWC.js';
+import { O as Orientation, T as Theme, P as PieceRenderer, C as ChessboardProps, A as AnimationOptions, R as ResolvedArrowPalette, U as UseChessGameOptions } from './types-4W8ULiE2.js';
+export { a as ArrowColors, D as DEFAULT_MOVE_HAPTIC_PATTERNS, b as DEFAULT_MOVE_SOUND_SOURCES, H as HapticFeedbackOptions, L as LegalTargetStyle, M as MoveFeedbackKey, c as MoveHapticKey, d as MoveHapticOptions, e as MoveHapticPatterns, f as MoveSoundKey, g as MoveSoundOptions, h as MoveSoundSources, i as PositionTransition, j as PromotionContext, k as RanksPosition, S as SquareContext, l as TriggerMoveHaptic, m as TriggerMoveSound, n as classifyMoveFeedback, t as triggerHaptic, o as triggerMoveHaptic, u as useMoveHaptics, p as useMoveSound, w as warmupHaptics } from './types-4W8ULiE2.js';
+export { c as createGigachessAdapter, p as preloadGigachessAdapter } from './gigachess-DN-ncmAU.js';
 export { HapticInput, TriggerOptions } from 'web-haptics';
 
+declare function formatFenPlacement(board: Uint8Array): string;
+interface BoardEditorProps {
+    /** Current FEN or placement string. */
+    fen?: string;
+    /** Called whenever the board placement changes. */
+    onChange?: (fen: string) => void;
+    /** Called when a specific square piece changes. */
+    onPieceChange?: (square: SquareIndex, cell: BoardCell, algebraic: string) => void;
+    /** Currently selected piece for placement (e.g. "wP", "bP", "wK", or null for eraser). */
+    selectedPiece?: string | null;
+    /** Callback when shortcut piece is chosen. */
+    onSelectPiece?: (piece: string | null) => void;
+    /** Board orientation (default "white"). */
+    orientation?: Orientation;
+    /** Board visual theme. */
+    theme?: Theme;
+    /** Piece renderer. */
+    pieces?: PieceRenderer;
+    /** Whether algebraic coordinates are shown. */
+    showCoordinates?: boolean;
+    /** Container style overrides. */
+    style?: CSSProperties;
+    /** Container class name. */
+    className?: string;
+    /** Accessible label. */
+    ariaLabel?: string;
+    /** Announce feedback callback (e.g. forward to useAriaLive). */
+    onAnnounce?: (message: string) => void;
+    /** Custom generator for square speech labels. */
+    getSquareAriaLabel?: (square: SquareIndex, cell: BoardCell, algebraic: string) => string;
+    /** Current focused square (controlled). */
+    focusedSquare?: SquareIndex;
+    /** Square focus callback. */
+    onSquareFocus?: (square: SquareIndex, cell: BoardCell, algebraic: string) => void;
+    /** Clear board callback. */
+    onClear?: () => void;
+    /** Set starting position callback. */
+    onSetStartingPosition?: () => void;
+    /** Toggle side to move callback. */
+    onToggleSideToMove?: () => void;
+}
+declare function BoardEditor({ fen, onChange, onPieceChange, selectedPiece, onSelectPiece, orientation, theme, pieces, showCoordinates, style, className, ariaLabel, onAnnounce, getSquareAriaLabel, focusedSquare: propFocusedSquare, onSquareFocus, onClear, onSetStartingPosition, onToggleSideToMove, }: BoardEditorProps): react_jsx_runtime.JSX.Element;
+
 /**
  * Interactive chess board.
  *
@@ -423,6 +466,10 @@ declare function getPointAtSquareCentre(container: HTMLElement, square: SquareIn
     readonly x: number;
     readonly y: number;
 };
+/** Algebraic name (`"a1"`, `"h8"`, …) for a square index. */
+declare function algebraicOf(square: SquareIndex): string;
+/** Square index for an algebraic name (`"a1"`, `"h8"`, …), or `null` if invalid. */
+declare function squareOf(algebraic: string): SquareIndex | null;
 
 declare const defaultPieces: PieceRenderer;
 
@@ -436,6 +483,6 @@ declare const defaultPieces: PieceRenderer;
  */
 
 /** Package version — keep in sync with `package.json`. */
-declare const PACKAGE_VERSION = "1.3.3";
+declare const PACKAGE_VERSION = "1.5.0";
 
-export { AnimationOptions, AnimationRunner, BoardCell, BoardModel, BoardSnapshot, CSS_VARS, Chessboard, ChessboardProps, DEFAULT_ILLEGAL_FLASH_TINT, DEFAULT_PREMOVE_TINT, type HoverSquareContext, Orientation, PACKAGE_VERSION, PackedMove, PieceRenderer, ResolvedArrowPalette, SquareIndex, Theme, UseChessGameOptions, defaultArrowColors, defaultPieces, defaultTheme, getPointAtSquareCentre, getSquareAtPoint, useArrowGesture, useBoardSlice, useBoardSnapshot, useChessGame, useClickToMove, useDrag, useHoverSquare, useKeyboardNav, useSquareCell };
+export { AnimationOptions, AnimationRunner, BoardCell, BoardEditor, type BoardEditorProps, BoardModel, BoardSnapshot, CSS_VARS, Chessboard, ChessboardProps, DEFAULT_ILLEGAL_FLASH_TINT, DEFAULT_PREMOVE_TINT, type HoverSquareContext, Orientation, PACKAGE_VERSION, PackedMove, PieceRenderer, ResolvedArrowPalette, SquareIndex, Theme, UseChessGameOptions, algebraicOf, defaultArrowColors, defaultPieces, defaultTheme, formatFenPlacement, getPointAtSquareCentre, getSquareAtPoint, squareOf, useArrowGesture, useBoardSlice, useBoardSnapshot, useChessGame, useClickToMove, useDrag, useHoverSquare, useKeyboardNav, useSquareCell };