@mirasen/chessboard 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mirasen/chessboard
 
+## 1.5.0
+
+### Minor Changes
+
+- 5c12439: Extend the check extension's `square` input to accept a color (`ColorInput`) in addition to a `SquareString`. When a color is provided, the highlight is placed on that color's king square.
+
 ## 1.4.0
 
 ### Minor Changes

package/dist/extensions/first-party/check/factory.js

@@ -1,9 +1,10 @@
 import assert from '@ktarmyshov/assert';
 import { toMerged } from 'es-toolkit';
-import { isSquareString } from '../../../state/board/check.js';
-import { denormalizeSquare } from '../../../state/board/denormalize.js';
-import { normalizeSquare } from '../../../state/board/normalize.js';
 import { createSvgElement, updateSvgElementAttributes } from '../../../render/svg/helpers.js';
+import { isColorInput, isSquareString } from '../../../state/board/check.js';
+import { normalizeColor, normalizeSquare } from '../../../state/board/normalize.js';
+import { toPieceCode } from '../../../state/board/piece.js';
+import { SQUARE_COUNT } from '../../../state/board/types/internal.js';
 import { isUpdateContextRenderable } from '../../types/context/update.js';
 import { extensionCreateInternalBase, extensionDestroyBase, extensionMountBase, extensionUnmountBase } from '../common/helpers.js';
 import { markHighlightDirtyAndRequestRender } from './invalidation.js';
@@ -22,6 +23,7 @@ function createCheckInternal(options, config) {
     return {
         ...extensionCreateInternalBase(options),
         square: null,
+        inputSquare: null,
         svgRect: null,
         svgGradient: null,
         runtimeSurface: options.runtimeSurface,
@@ -35,10 +37,23 @@ function extensionClean(state) {
 function createCheckInstancePublic(state) {
     return {
         get square() {
-            return state.square === null ? null : denormalizeSquare(state.square);
+            return state.inputSquare;
         },
         set square(value) {
-            const next = value === null ? null : normalizeSquare(assertSquareString(value));
+            let next;
+            if (value === null) {
+                next = null;
+            }
+            else if (isSquareString(value)) {
+                next = normalizeSquare(value);
+            }
+            else if (isColorInput(value)) {
+                next = findKing(state, value);
+            }
+            else {
+                throw new TypeError(`Invalid check square: ${String(value)}`);
+            }
+            state.inputSquare = value;
             if (next === state.square) {
                 return; // no-op: same square (or both null)
             }
@@ -47,11 +62,18 @@ function createCheckInstancePublic(state) {
         }
     };
 }
-function assertSquareString(value) {
-    if (!isSquareString(value)) {
-        throw new TypeError(`Invalid check square: ${String(value)}`);
+function findKing(state, color) {
+    const snapshot = state.runtimeSurface.commands.getSnapshot();
+    const pieces = snapshot.state.board.pieces;
+    const colorCode = normalizeColor(color);
+    const kingPieceCode = toPieceCode(6 /* RoleCode.King */, colorCode);
+    for (let sq = 0; sq < SQUARE_COUNT; sq++) {
+        const piece = pieces[sq];
+        if (piece === kingPieceCode) {
+            return sq;
+        }
     }
-    return value;
+    throw new Error("King of color '" + color + "' not found");
 }
 function removeHighlight(state) {
     if (state.svgRect !== null) {

package/dist/extensions/first-party/check/types.d.ts

@@ -1,9 +1,9 @@
 import { PartialDeep } from 'type-fest';
+import type { ColorInput, SquareString } from '../../../state/board/types/input.js';
 import type { Square } from '../../../state/board/types/internal.js';
 import { ExtensionDefinition, ExtensionInstance } from '../../types/extension.js';
-import { ExtensionInternalBase, OpaqueColor } from '../common/types.js';
 import type { ExtensionRuntimeSurface } from '../../types/surface/main.js';
-import type { SquareString } from '../../../state/board/types/input.js';
+import { ExtensionInternalBase, OpaqueColor } from '../common/types.js';
 export declare const EXTENSION_SLOTS: readonly ["defs", "underPieces"];
 export type ExtensionSlotsType = typeof EXTENSION_SLOTS;
 export declare const EXTENSION_ID: "check";
@@ -24,12 +24,13 @@ export declare const GRADIENT_STOPS: readonly [{
 }];
 export type CheckInitConfig = PartialDeep<CheckConfig>;
 export type CheckPublic = {
-    square: SquareString | null;
+    square: SquareString | ColorInput | null;
 };
 export type CheckDefinition = ExtensionDefinition<typeof EXTENSION_ID, typeof EXTENSION_SLOTS, CheckPublic>;
 export type CheckInstance = ExtensionInstance<typeof EXTENSION_ID, typeof EXTENSION_SLOTS, CheckPublic>;
 export interface CheckInstanceInternal extends ExtensionInternalBase<ExtensionSlotsType> {
     square: Square | null;
+    inputSquare: SquareString | ColorInput | null;
     svgRect: SVGRectElement | null;
     svgGradient: SVGRadialGradientElement | null;
     readonly runtimeSurface: ExtensionRuntimeSurface;

package/dist/state/board/check.d.ts

@@ -1,4 +1,4 @@
-import { Color, ColorShort, MoveRequestInput, Piece, PiecePositionInput, PiecePositionRecord, PiecePositionRecordShort, PiecePositionRecordString, PieceShort, PieceString, Role, RoleShort, SquareString } from './types/input.js';
+import { Color, ColorInput, ColorShort, MoveRequestInput, Piece, PiecePositionInput, PiecePositionRecord, PiecePositionRecordShort, PiecePositionRecordString, PieceShort, PieceString, Role, RoleShort, SquareString } from './types/input.js';
 import { EmptyPieceCode, MoveRequest, NonEmptyPieceCode, PieceCode, PiecePositionSnapshot, PositionSnapshot, RolePromotionCode, Square, SquareFile, SquareRank } from './types/internal.js';
 import type { BoardStateSnapshot } from './types/main.js';
 export declare function isWhitePieceCode(code: NonEmptyPieceCode): boolean;
@@ -17,6 +17,7 @@ export declare function isPieceString(value: unknown): value is PieceString;
 export declare function isSquareString(value: unknown): value is SquareString;
 export declare function isPositionMapString(pos: PiecePositionInput): pos is PiecePositionRecordString;
 export declare function isColorShort(value: unknown): value is ColorShort;
+export declare function isColorInput(value: unknown): value is ColorInput;
 export declare function isRoleShort(value: unknown): value is RoleShort;
 export declare function isPieceShort(value: unknown): value is PieceShort;
 export declare function isPositionMapShort(pos: PiecePositionInput): pos is PiecePositionRecordShort;

package/dist/state/board/check.js

@@ -74,6 +74,9 @@ export function isPositionMapString(pos) {
 export function isColorShort(value) {
     return value === 'w' || value === 'b';
 }
+export function isColorInput(value) {
+    return isColor(value) || isColorShort(value);
+}
 export function isRoleShort(value) {
     return (value === 'K' ||
         value === 'Q' ||

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@mirasen/chessboard",
 	"description": "Production-grade framework-agnostic TypeScript chessboard platform with real chess interaction built in.",
-	"version": "1.4.0",
+	"version": "1.5.0",
 	"license": "MIT",
 	"author": {
 		"name": "Mirasen"