@mirasen/chessboard 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mirasen/chessboard
 
+## 1.0.6
+
+### Patch Changes
+
+- e81b3fd: Fix scheduler `flushNow()` so pending frames flush synchronously.
+
+## 1.0.5
+
+### Patch Changes
+
+- 0422020: Fix fast drag-and-drop sometimes leaving a stale drag visual due to an unsynced target square.
+- 0422020: Update dependencies
+- 0422020: Fix promotion extension to accept renderer-compatible piece URL maps without throwing on extra entries.
+- 0422020: Allow createBoard options to configure built-in extensions without direct factory calls.
+
 ## 1.0.4
 
 ### Patch Changes

package/README.md

@@ -1,5 +1,7 @@
 [![NPM Version](https://img.shields.io/npm/v/%40mirasen%2Fchessboard)](https://www.npmjs.com/package/@mirasen/chessboard)
 [![CI](https://github.com/mirasen-io/chessboard/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mirasen-io/chessboard/actions/workflows/ci.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mirasen-io_chessboard&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=mirasen-io_chessboard)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mirasen-io_chessboard&metric=coverage)](https://sonarcloud.io/summary/new_code?id=mirasen-io_chessboard)
 [![License](https://img.shields.io/npm/l/@mirasen/chessboard)](./LICENSE)
 
 # @mirasen/chessboard
@@ -37,9 +39,15 @@ The default first-party extension baseline includes rendering, events, selection
 
 That means the board already covers a meaningful baseline chess UX instead of stopping at “draw squares and pieces”.
 
+### Built-in chessboard behavior
+
+Mirasen Chessboard provides a complete modern interaction and visual baseline out of the box: selection, deselection, reselection, drag-to-move, release targeting, legal destinations, promotion, auto-promotion, and state-diff animation. Moves are resolved on release rather than committed immediately on press, giving users a more forgiving interaction flow. Because animation is driven by board-state transitions, pieces can move, appear, disappear, promote, or return smoothly without app-level glue code.
+
 ## Highlights
 
 - Real built-in chess interaction
+- Easy game/rules layer integration
+- State-diff animation beyond simple move events
 - Extension-driven architecture
 - First-party baseline extensions
 - Explicit SVG slot ownership

package/dist/extensions/build/index.d.ts

@@ -1,3 +1,4 @@
+export { cleanAnimationPlan, prepareAnimationPlan, renderAnimationPlan } from '../../animation/render/plan.js';
 export { clearElementChildren, createSvgElement, updateElementAttributes } from '../../render/svg/helpers.js';
 export type { RuntimeReadonlyMutationSession } from '../../runtime/mutation/types.js';
 export { isNonEmptyPieceCode } from '../../state/board/check.js';

package/dist/extensions/build/index.js

@@ -1,3 +1,4 @@
+export { cleanAnimationPlan, prepareAnimationPlan, renderAnimationPlan } from '../../animation/render/plan.js';
 export { clearElementChildren, createSvgElement, updateElementAttributes } from '../../render/svg/helpers.js';
 export { isNonEmptyPieceCode } from '../../state/board/check.js';
 export { fileOf, rankOf, squareOf } from '../../state/board/coords.js';

package/dist/extensions/first-party/promotion/normalize.js

@@ -6,21 +6,23 @@ function assertPieceUrlsComplete(pieceUrls) {
         assert(pieceCode in pieceUrls, `Missing URL for piece code: ${pieceCode}`);
     }
 }
-function assertPieceCodeIsPromotionPieceCode(pieceCode) {
-    assert(pieceCode === 5 /* PieceCode.WhiteQueen */ ||
+function isPromotionPieceCode(pieceCode) {
+    return (pieceCode === 5 /* PieceCode.WhiteQueen */ ||
         pieceCode === 4 /* PieceCode.WhiteRook */ ||
         pieceCode === 3 /* PieceCode.WhiteBishop */ ||
         pieceCode === 2 /* PieceCode.WhiteKnight */ ||
         pieceCode === 13 /* PieceCode.BlackQueen */ ||
         pieceCode === 12 /* PieceCode.BlackRook */ ||
         pieceCode === 11 /* PieceCode.BlackBishop */ ||
-        pieceCode === 10 /* PieceCode.BlackKnight */, `Invalid promotion piece code: ${pieceCode}`);
+        pieceCode === 10 /* PieceCode.BlackKnight */);
 }
 function normalizePromotionPieceUrls(input) {
     const normalized = {};
     for (const [key, url] of Object.entries(input)) {
         const pieceCode = normalizePiece(key);
-        assertPieceCodeIsPromotionPieceCode(pieceCode);
+        if (!isPromotionPieceCode(pieceCode)) {
+            continue;
+        }
         normalized[pieceCode] = url;
     }
     assertPieceUrlsComplete(normalized);

package/dist/extensions/types/wrapper.d.ts

@@ -1,6 +1,3 @@
-/**
- * Public built-in extension ids accepted by createBoard({ extensions })
- */
 import { createActiveTarget } from '../first-party/active-target/factory.js';
 import { createAutoPromote } from '../first-party/auto-promote/factory.js';
 import { createBoardEvents } from '../first-party/board-events/factory.js';

package/dist/extensions/types/wrapper.js

@@ -1,6 +1,3 @@
-/**
- * Public built-in extension ids accepted by createBoard({ extensions })
- */
 import { createActiveTarget } from '../first-party/active-target/factory.js';
 import { EXTENSION_ID as EXTENSION_ID_ACTIVE_TARGET } from '../first-party/active-target/types.js';
 import { createAutoPromote } from '../first-party/auto-promote/factory.js';

package/dist/render/scheduler/scheduler.js

@@ -3,16 +3,14 @@ export function createScheduler(opts) {
     let scheduled = false;
     let runId = 0;
     let rafHandle = null;
-    const flushCore = () => {
-        if (!scheduled && rafHandle == null) {
+    const flushCore = (force = false) => {
+        if (!force && !scheduled && rafHandle == null) {
             // Maybe was cancelled after the rAF callback was scheduled but before it fired.
             return;
         }
         // Reset scheduled flags first to allow schedule() during render to queue the next frame.
         scheduled = false;
-        if (rafHandle != null) {
-            rafHandle = null;
-        }
+        rafHandle = null;
         render();
     };
     return {
@@ -29,17 +27,16 @@ export function createScheduler(opts) {
             });
         },
         flushNow() {
+            if (!scheduled && rafHandle == null)
+                return;
             // Invalidate any pending rAF render immediately.
-            if (scheduled) {
-                runId++;
-                scheduled = false;
-            }
+            runId++;
             if (rafHandle != null) {
                 const caf = globalThis.cancelAnimationFrame;
                 caf(rafHandle);
                 rafHandle = null;
             }
-            flushCore();
+            flushCore(true);
         },
         cancel() {
             scheduled = false;

package/dist/runtime/factory/input.js

@@ -42,23 +42,24 @@ export function createRuntimeInteractionSurface(state) {
             const internalState = state();
             const mutationSession = internalState.mutation.getSession();
             const interaction = internalState.state.interaction;
+            interaction.updateDragSessionCurrentTarget(target, mutationSession);
             const dragSession = interaction.dragSession;
-            assert(dragSession !== null, 'completeDragTo requires an active drag session');
             assert(isDragSessionCoreOwned(dragSession), 'completeDragTo can only be called for core-owned drag sessions');
             uiMoveCompleteTo(internalState, target);
-            mutationSession.addMutation('runtime.interaction.completeDragTo', true, dragSession);
+            mutationSession.addMutation('runtime.interaction.completeCoreDragTo', true, dragSession);
             runtimeRunMutationPipeline(internalState);
         },
         completeExtensionDrag(target) {
             const internalState = state();
             const mutationSession = internalState.mutation.getSession();
             const interaction = internalState.state.interaction;
+            interaction.updateDragSessionCurrentTarget(target, mutationSession);
             const dragSession = interaction.dragSession;
-            assert(dragSession !== null, 'completeExtensionDrag requires an active drag session');
             assert(!isDragSessionCoreOwned(dragSession), 'completeExtensionDrag can only be called for extension-owned drag sessions');
-            assert(dragSession.targetSquare === target, 'The target square in completeExtensionDrag must match the current target square of the drag session');
             internalState.extensionSystem.completeDrag(dragSession);
             internalState.state.interaction.setDragSession(null, mutationSession);
+            mutationSession.addMutation('runtime.interaction.completeExtensionDragTo', true, dragSession);
+            runtimeRunMutationPipeline(internalState);
         },
         startReleaseTargetingDrag(source, target) {
             const internalState = state();
@@ -92,9 +93,7 @@ export function createRuntimeInteractionSurface(state) {
             const internalState = state();
             const interactionMutationSession = internalState.mutation.getSession();
             const interaction = internalState.state.interaction;
-            const currentDragSession = interaction.dragSession;
-            assert(currentDragSession !== null, 'No active drag session to update');
-            internalState.state.interaction.updateDragSessionCurrentTarget(target, interactionMutationSession);
+            interaction.updateDragSessionCurrentTarget(target, interactionMutationSession);
             runtimeRunMutationPipeline(internalState);
         },
         onEvent(context) {

package/dist/runtime/input/adapter/factory.js

@@ -19,7 +19,7 @@ export function createInputAdapter(options) {
             internalState.container.addEventListener(type, onEventHander);
         },
         unsubscribeEvent(type) {
-            assert(NEED_EVENT_TYPES.has(type), `Unsubscribe for event type ${type} is not supported. This is required event type for the board to function properly.`);
+            assert(!NEED_EVENT_TYPES.has(type), `Unsubscribe for event type ${type} is not supported. This is required event type for the board to function properly.`);
             internalState.container.removeEventListener(type, onEventHander);
         },
         destroy() {

package/dist/runtime/mutation/interaction.js

@@ -4,7 +4,7 @@ export const reconcileInteractionSelectionAfterBoardStateChange = (context, muta
     const { current } = context;
     if (!mutationSession.hasMutation({ prefixes: ['state.board.'] }) ||
         mutationSession.hasMutation({
-            causes: ['state.interaction.clear', 'runtime.interaction.completeDragTo']
+            causes: ['state.interaction.clear', 'runtime.interaction.completeCoreDragTo']
         })) {
         return;
     }

package/dist/runtime/mutation/types.d.ts

@@ -3,10 +3,11 @@ import type { MutationSession, ReadonlyMutationSession } from '../../mutation/ty
 import type { BoardStateMutationPayloadByCause } from '../../state/board/mutation.js';
 import type { ChangeStateMutationPayloadByCause } from '../../state/change/mutation.js';
 import type { InteractionStateMutationPayloadByCause } from '../../state/interaction/mutation.js';
-import type { DragSessionCoreOwnedSnapshot } from '../../state/interaction/types/internal.js';
+import type { DragSessionCoreOwnedSnapshot, DragSessionExtensionOwnedSnapshot } from '../../state/interaction/types/internal.js';
 import type { ViewStateMutationPayloadByCause } from '../../state/view/mutation.js';
 type RuntimeOwnMutationPayloadByCause = {
-    'runtime.interaction.completeDragTo': DragSessionCoreOwnedSnapshot;
+    'runtime.interaction.completeCoreDragTo': DragSessionCoreOwnedSnapshot;
+    'runtime.interaction.completeExtensionDragTo': DragSessionExtensionOwnedSnapshot;
     'runtime.interaction.resolveDeferredUIMoveRequest': undefined;
     'runtime.interaction.cancelDeferredUIMoveRequest': undefined;
 };

package/dist/wrapper/factory.d.ts

@@ -1,3 +1,3 @@
 import { DefaultBuiltinChessboardExtensions } from '../extensions/types/wrapper.js';
-import { Chessboard, ChessboardExtensionInput, ChessboardInitOptions } from './types.js';
+import { type Chessboard, type ChessboardExtensionInput, type ChessboardInitOptions } from './types.js';
 export declare function createBoard<TExtensions extends readonly ChessboardExtensionInput[] = DefaultBuiltinChessboardExtensions>(options: ChessboardInitOptions<TExtensions>): Chessboard<TExtensions>;

package/dist/wrapper/factory.js

@@ -1,5 +1,9 @@
 import { builtInExtensionFactoryMap, DefaultBuiltinChessboardExtensions } from '../extensions/types/wrapper.js';
 import { createRuntime } from '../runtime/factory/main.js';
+function resolveBuiltInExtensionWithOptions(input) {
+    const factory = builtInExtensionFactoryMap[input.builtin];
+    return factory(input.options);
+}
 export function createBoard(options) {
     // prepare init options for runtime
     const extensionsInput = options.extensions ?? DefaultBuiltinChessboardExtensions;
@@ -8,6 +12,10 @@ export function createBoard(options) {
             // built-in extension, convert to definition
             return builtInExtensionFactoryMap[ext]();
         }
+        if ('builtin' in ext) {
+            // built-in extension with options, convert to definition
+            return resolveBuiltInExtensionWithOptions(ext);
+        }
         // assume it's already a definition
         return ext;
     });

package/dist/wrapper/types.d.ts

@@ -1,15 +1,25 @@
 import type { AnyExtensionDefinition, ExtensionDefinitionId, ExtensionDefinitionPublicApi } from '../extensions/types/extension.js';
-import { BuiltInExtensionDefinitionMap, BuiltInExtensionId, DefaultBuiltinChessboardExtensions } from '../extensions/types/wrapper.js';
-import { Runtime } from '../runtime/types/main.js';
-import { RuntimeStateInitOptions } from '../state/types.js';
+import { type BuiltInExtensionDefinitionMap, type BuiltInExtensionId, type DefaultBuiltinChessboardExtensions, builtInExtensionFactoryMap } from '../extensions/types/wrapper.js';
+import type { Runtime } from '../runtime/types/main.js';
+import type { RuntimeStateInitOptions } from '../state/types.js';
 /**
  * What createBoard accepts in options.extensions
  */
-export type ChessboardExtensionInput = BuiltInExtensionId | AnyExtensionDefinition;
+export type BuiltInExtensionFactoryInitOptions<TId extends BuiltInExtensionId> = Parameters<(typeof builtInExtensionFactoryMap)[TId]> extends [] ? never : NonNullable<Parameters<(typeof builtInExtensionFactoryMap)[TId]>[0]>;
+type BuiltInExtensionIdsWithOptions = {
+    [TId in BuiltInExtensionId]: [BuiltInExtensionFactoryInitOptions<TId>] extends [never] ? never : TId;
+}[BuiltInExtensionId];
+export type BuiltInExtensionInitOptions = {
+    [TId in BuiltInExtensionIdsWithOptions]: {
+        builtin: TId;
+        options: BuiltInExtensionFactoryInitOptions<TId>;
+    };
+}[BuiltInExtensionIdsWithOptions];
+export type ChessboardExtensionInput = BuiltInExtensionId | BuiltInExtensionInitOptions | AnyExtensionDefinition;
 /**
  * Resolve one public input item into a concrete extension definition type
  */
-export type ResolveChessboardExtensionInput<T> = T extends keyof BuiltInExtensionDefinitionMap ? BuiltInExtensionDefinitionMap[T] : T extends AnyExtensionDefinition ? T : never;
+export type ResolveChessboardExtensionInput<T> = T extends keyof BuiltInExtensionDefinitionMap ? BuiltInExtensionDefinitionMap[T] : T extends BuiltInExtensionInitOptions ? T['builtin'] extends keyof BuiltInExtensionDefinitionMap ? BuiltInExtensionDefinitionMap[T['builtin']] : never : T extends AnyExtensionDefinition ? T : never;
 /**
  * Resolve an input tuple into a tuple of concrete extension definitions
  */

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@mirasen/chessboard",
 	"description": "Framework-agnostic TypeScript chessboard platform with real chess interaction built in.",
-	"version": "1.0.4",
+	"version": "1.0.6",
 	"license": "MIT",
 	"author": {
 		"name": "Mirasen",