@mirasen/chessboard 0.1.1 → 1.0.0

package/dist/state/change/{factory.js → factory/main.js}

@@ -1,9 +1,9 @@
 import { cloneDeep } from 'es-toolkit/object';
-import { changeStateSetDeferredUIMoveRequestContext, changeStateSetLastMove } from './reducers.js';
+import { changeStateSetDeferredUIMoveRequest, changeStateSetLastMove } from '../reducers.js';
 function createChangeStateInternal() {
     return {
         lastMove: null,
-        deferredUIMoveRequestContext: null
+        deferredUIMoveRequest: null
     };
 }
 export function createChangeState() {
@@ -12,17 +12,20 @@ export function createChangeState() {
         get lastMove() {
             return cloneDeep(internalState.lastMove);
         },
+        get deferredUIMoveRequest() {
+            return cloneDeep(internalState.deferredUIMoveRequest);
+        },
         setLastMove(move, mutationSession) {
             return mutationSession.addMutation('state.change.setLastMove', changeStateSetLastMove(internalState, move));
         },
         getSnapshot() {
             return {
                 ...cloneDeep(internalState),
-                deferredUIMoveRequestContext: internalState.deferredUIMoveRequestContext?.getSnapshot() ?? null
+                deferredUIMoveRequest: internalState.deferredUIMoveRequest?.getSnapshot() ?? null
             };
         },
-        setDeferredUIMoveRequestContext(context, mutationSession) {
-            return mutationSession.addMutation('state.change.setDeferredUIMoveRequestContext', changeStateSetDeferredUIMoveRequestContext(internalState, context));
+        setDeferredUIMoveRequest(request, mutationSession) {
+            return mutationSession.addMutation('state.change.setDeferredUIMoveRequest', changeStateSetDeferredUIMoveRequest(internalState, request));
         }
     };
 }

package/dist/state/change/factory/ui-move.d.ts

@@ -0,0 +1,4 @@
+import { Square } from '../../board/types/internal.js';
+import { MoveDestinationSnapshot } from '../../interaction/types/internal.js';
+import { PendingUIMoveRequest } from '../types/ui-move.js';
+export declare function createPendingUIMoveRequest(sourceSquare: Square, destination: MoveDestinationSnapshot): PendingUIMoveRequest;

package/dist/{runtime → state/change}/factory/ui-move.js

@@ -1,4 +1,4 @@
-function createMoveRequestContextInternal(sourceSquare, destination) {
+function createPendingUIMoveRequestInternal(sourceSquare, destination) {
     return {
         sourceSquare,
         destination,
@@ -6,7 +6,7 @@ function createMoveRequestContextInternal(sourceSquare, destination) {
         resolvedMoveRequest: null
     };
 }
-function moveRequestContextCanBeAutoResolved(state) {
+function pendingUIMoveRequestCanBeAutoResolved(state) {
     return (state.status === 'unresolved' &&
         (state.destination.promotedTo === undefined || state.destination.promotedTo.length <= 1));
 }
@@ -21,11 +21,11 @@ function assertCanBeResolved(state) {
     }
 }
 function assertCanBeAutoResolved(state) {
-    if (!moveRequestContextCanBeAutoResolved(state)) {
+    if (!pendingUIMoveRequestCanBeAutoResolved(state)) {
         throw new Error('Move request cannot be auto-resolved. Either it is already resolved or deferred, or it requires a promotion choice.');
     }
 }
-function moveRequestContextAutoResolve(state) {
+function pendingUIMoveRequestAutoResolve(state) {
     assertCanBeAutoResolved(state);
     const promotedTo = state.destination.promotedTo?.length === 1 ? state.destination.promotedTo[0] : undefined;
     state.status = 'resolved';
@@ -41,8 +41,8 @@ function moveRequestContextAutoResolve(state) {
         ...(promotedTo !== undefined ? { promotedTo } : {})
     };
 }
-export function createUIMoveRequestContext(sourceSquare, destination) {
-    const internalState = createMoveRequestContextInternal(sourceSquare, destination);
+export function createPendingUIMoveRequest(sourceSquare, destination) {
+    const internalState = createPendingUIMoveRequestInternal(sourceSquare, destination);
     return {
         get status() {
             return internalState.status;
@@ -54,7 +54,7 @@ export function createUIMoveRequestContext(sourceSquare, destination) {
             return internalState.destination;
         },
         get canBeAutoResolved() {
-            return moveRequestContextCanBeAutoResolved(internalState);
+            return pendingUIMoveRequestCanBeAutoResolved(internalState);
         },
         get resolvedMoveRequest() {
             return internalState.resolvedMoveRequest;
@@ -69,14 +69,14 @@ export function createUIMoveRequestContext(sourceSquare, destination) {
             internalState.resolvedMoveRequest = request;
         },
         autoresolve() {
-            moveRequestContextAutoResolve(internalState);
+            pendingUIMoveRequestAutoResolve(internalState);
         },
         getSnapshot() {
             return {
                 status: internalState.status,
                 sourceSquare: internalState.sourceSquare,
                 destination: internalState.destination,
-                canBeAutoResolved: moveRequestContextCanBeAutoResolved(internalState),
+                canBeAutoResolved: pendingUIMoveRequestCanBeAutoResolved(internalState),
                 resolvedMoveRequest: internalState.resolvedMoveRequest
             };
         }

package/dist/state/change/helpers.d.ts

@@ -1,8 +1,10 @@
-import { ExtensionUIMoveRequestContextSnapshot } from '../../extensions/types/context/ui-move.js';
 import type { MoveRequest, MoveRequestBase, MoveSnapshot } from '../board/types/internal.js';
 import { MoveDestinationSnapshot } from '../interaction/types/internal.js';
+import { ChangeStateSnapshot } from './types/main.js';
+import { PendingUIMoveRequestSnapshot } from './types/ui-move.js';
 export declare function movesEqual(moveA: MoveSnapshot | null, moveB: MoveSnapshot | null): boolean;
 export declare function moveRequestBasesEqual(requestA: MoveRequestBase | null, requestB: MoveRequestBase | null): boolean;
 export declare function moveRequestsEqual(requestA: MoveRequest | null, requestB: MoveRequest | null): boolean;
 export declare function moveDestinationsEqual(destA: MoveDestinationSnapshot | null, destB: MoveDestinationSnapshot | null): boolean;
-export declare function uiMoveRequestContextsEqual(contextA: ExtensionUIMoveRequestContextSnapshot | null, contextB: ExtensionUIMoveRequestContextSnapshot | null): boolean;
+export declare function pendingUIMoveRequestsEqual(contextA: PendingUIMoveRequestSnapshot | null, contextB: PendingUIMoveRequestSnapshot | null): boolean;
+export declare function changeStatesEqual(stateA: ChangeStateSnapshot | null, stateB: ChangeStateSnapshot | null): boolean;

package/dist/state/change/helpers.js

@@ -69,7 +69,7 @@ export function moveDestinationsEqual(destA, destB) {
         setsEqual(new Set(destA.promotedTo ?? []), new Set(destB.promotedTo ?? [])) &&
         moveRequestBasesEqual(destA.secondary ?? null, destB.secondary ?? null));
 }
-export function uiMoveRequestContextsEqual(contextA, contextB) {
+export function pendingUIMoveRequestsEqual(contextA, contextB) {
     if (contextA === null && contextB === null) {
         return true;
     }
@@ -84,3 +84,13 @@ export function uiMoveRequestContextsEqual(contextA, contextB) {
         contextA.canBeAutoResolved === contextB.canBeAutoResolved &&
         moveRequestsEqual(contextA.resolvedMoveRequest, contextB.resolvedMoveRequest));
 }
+export function changeStatesEqual(stateA, stateB) {
+    if (stateA === null && stateB === null) {
+        return true;
+    }
+    if (stateA === null || stateB === null) {
+        return false;
+    }
+    return (pendingUIMoveRequestsEqual(stateA.deferredUIMoveRequest, stateB.deferredUIMoveRequest) &&
+        movesEqual(stateA.lastMove, stateB.lastMove));
+}

package/dist/state/change/mutation.d.ts

@@ -1,6 +1,6 @@
 import type { MutationSession } from '../../mutation/types.js';
 export type ChangeStateMutationPayloadByCause = {
     'state.change.setLastMove': undefined;
-    'state.change.setDeferredUIMoveRequestContext': undefined;
+    'state.change.setDeferredUIMoveRequest': undefined;
 };
 export type ChangeStateMutationSession = MutationSession<ChangeStateMutationPayloadByCause>;

package/dist/state/change/reducers.d.ts

@@ -1,5 +1,5 @@
-import { ExtensionUIMoveRequestContext } from '../../extensions/types/context/ui-move.js';
 import type { MoveSnapshot } from '../board/types/internal.js';
-import type { ChangeStateInternal } from './types.js';
+import { ChangeStateInternal } from './types/main.js';
+import { PendingUIMoveRequest } from './types/ui-move.js';
 export declare function changeStateSetLastMove(state: ChangeStateInternal, move: MoveSnapshot | null): boolean;
-export declare function changeStateSetDeferredUIMoveRequestContext(state: ChangeStateInternal, context: ExtensionUIMoveRequestContext): boolean;
+export declare function changeStateSetDeferredUIMoveRequest(state: ChangeStateInternal, request: PendingUIMoveRequest | null): boolean;

package/dist/state/change/reducers.js

@@ -1,5 +1,5 @@
 import { cloneDeep } from 'es-toolkit/object';
-import { movesEqual, uiMoveRequestContextsEqual } from './helpers.js';
+import { movesEqual, pendingUIMoveRequestsEqual } from './helpers.js';
 export function changeStateSetLastMove(state, move) {
     if (movesEqual(state.lastMove, move)) {
         return false; // No change
@@ -7,10 +7,10 @@ export function changeStateSetLastMove(state, move) {
     state.lastMove = cloneDeep(move);
     return true;
 }
-export function changeStateSetDeferredUIMoveRequestContext(state, context) {
-    if (uiMoveRequestContextsEqual(state.deferredUIMoveRequestContext, context)) {
+export function changeStateSetDeferredUIMoveRequest(state, request) {
+    if (pendingUIMoveRequestsEqual(state.deferredUIMoveRequest, request)) {
         return false; // No change
     }
-    state.deferredUIMoveRequestContext = context;
+    state.deferredUIMoveRequest = request;
     return true;
 }

package/dist/state/change/types/main.d.ts

@@ -0,0 +1,18 @@
+import type { ReadonlyDeep } from 'type-fest';
+import { MoveSnapshot } from '../../board/types/internal.js';
+import type { ChangeStateMutationSession } from '../mutation.js';
+import { PendingUIMoveRequest, PendingUIMoveRequestSnapshot } from './ui-move.js';
+export interface ChangeStateInternal {
+    lastMove: MoveSnapshot | null;
+    deferredUIMoveRequest: PendingUIMoveRequest | null;
+}
+export type ChangeStateSnapshot = ReadonlyDeep<Omit<ChangeStateInternal, 'deferredUIMoveRequest'>> & {
+    deferredUIMoveRequest: PendingUIMoveRequestSnapshot | null;
+};
+export interface ChangeState {
+    readonly lastMove: MoveSnapshot | null;
+    readonly deferredUIMoveRequest: PendingUIMoveRequest | null;
+    setLastMove(move: MoveSnapshot | null, mutationSession: ChangeStateMutationSession): boolean;
+    setDeferredUIMoveRequest(request: PendingUIMoveRequest | null, mutationSession: ChangeStateMutationSession): boolean;
+    getSnapshot(): ChangeStateSnapshot;
+}

package/dist/state/change/types/main.js

@@ -0,0 +1 @@
+export {};

package/dist/state/change/types/ui-move.d.ts

@@ -0,0 +1,25 @@
+import { MoveRequest, RolePromotionCode, Square } from '../../board/types/internal.js';
+import { MoveDestinationSnapshot } from '../../interaction/types/internal.js';
+export type PendingUIMoveRequestStatus = 'unresolved' | 'deferred' | 'resolved';
+export interface PendingUIMoveRequestSnapshot {
+    readonly status: PendingUIMoveRequestStatus;
+    readonly sourceSquare: Square;
+    readonly destination: MoveDestinationSnapshot;
+    readonly canBeAutoResolved: boolean;
+    readonly resolvedMoveRequest: MoveRequest | null;
+}
+export interface PendingUIMoveRequest extends PendingUIMoveRequestSnapshot {
+    defer(): void;
+    resolve(request: MoveRequest): void;
+    autoresolve(): void;
+    getSnapshot(): PendingUIMoveRequestSnapshot;
+}
+export interface PendingUIMoveRequestInternal {
+    readonly sourceSquare: Square;
+    readonly destination: MoveDestinationSnapshot;
+    status: PendingUIMoveRequestStatus;
+    resolvedMoveRequest: MoveRequest | null;
+}
+export interface DeferredUIMoveResolutionDetails {
+    readonly promotedTo: RolePromotionCode;
+}

package/dist/state/change/types/ui-move.js

@@ -0,0 +1 @@
+export {};

package/dist/state/factory.js

@@ -1,5 +1,5 @@
 import { createBoardState } from './board/factory.js';
-import { createChangeState } from './change/factory.js';
+import { createChangeState } from './change/factory/main.js';
 import { createInteractionState } from './interaction/factory.js';
 import { createViewState } from './view/factory.js';
 function createRuntimeStateInternal(options) {

package/dist/state/interaction/factory.js

@@ -51,8 +51,10 @@ export function createInteractionState(options) {
             return internalState.dragSession ? { ...internalState.dragSession } : null;
         },
         setDragSession(session, mutationSession) {
-            // Assert that the selected is the same as the source of the drag session when setting a lifted-piece-drag session
-            if (session) {
+            // assert that there is no active session when setting a new session.
+            assert(session === null || internalState.dragSession === null, 'Cannot set a new drag session while another session is active');
+            if (session && session.owner === 'core') {
+                // Assert that the selected is the same as the source of the drag session when setting a lifted-piece-drag session
                 assert(internalState.selected, 'There must be a selected piece to start a drag session');
                 if (session.type === 'lifted-piece-drag') {
                     assert(internalState.selected, 'There must be a selected piece to start a lifted-piece-drag session');

package/dist/state/interaction/helpers.d.ts

@@ -1,4 +1,6 @@
 import { InteractionStateMutationSession } from './mutation.js';
+import { DragSessionCoreOwnedSnapshot, DragSessionSnapshot } from './types/internal.js';
 import { InteractionStateInternal, InteractionStateSelected } from './types/main.js';
 export declare function selectedEqual(a: InteractionStateSelected | null, b: InteractionStateSelected | null): boolean;
 export declare function updateActiveDestinations(state: InteractionStateInternal, mutationSession: InteractionStateMutationSession): boolean;
+export declare function isDragSessionCoreOwned(session: DragSessionSnapshot): session is DragSessionCoreOwnedSnapshot;

package/dist/state/interaction/helpers.js

@@ -14,3 +14,6 @@ export function updateActiveDestinations(state, mutationSession) {
     const activeDests = getActiveDestinations(state, state.selected.square);
     return mutationSession.addMutation('state.interaction.updateActiveDestinations', interactionSetActiveDestinations(state, activeDests));
 }
+export function isDragSessionCoreOwned(session) {
+    return session.owner === 'core';
+}

package/dist/state/interaction/types/internal.d.ts

@@ -1,11 +1,19 @@
 import type { ReadonlyDeep } from 'type-fest';
+import type { ExtensionDragSession, ExtensionDragSessionBase } from '../../../extensions/types/basic/interaction.js';
 import type { MoveRequest, PieceCode, RolePromotionCode, Square } from '../../board/types/internal.js';
-export interface DragSession {
+export type DragSessionExtensionOwned = ExtensionDragSession & {
+    owner: string;
+};
+export type DragSessionExtensionOwnedSnapshot = ReadonlyDeep<DragSessionExtensionOwned>;
+export interface DragSessionCoreOwned extends ExtensionDragSessionBase {
+    owner: 'core';
     type: 'lifted-piece-drag' | 'release-targeting';
     sourceSquare: Square;
     sourcePieceCode: PieceCode;
     targetSquare: Square | null;
 }
+export type DragSessionCoreOwnedSnapshot = ReadonlyDeep<DragSessionCoreOwned>;
+export type DragSession = DragSessionCoreOwned | DragSessionExtensionOwned;
 export type DragSessionSnapshot = ReadonlyDeep<DragSession>;
 export interface MoveDestination extends Omit<MoveRequest, 'from' | 'promotedTo'> {
     promotedTo?: RolePromotionCode[];

package/dist/state/types.d.ts

@@ -1,6 +1,6 @@
 import { PositionInput } from './board/types/input.js';
 import { BoardState, BoardStateSnapshot } from './board/types/main.js';
-import type { ChangeState, ChangeStateSnapshot } from './change/types.js';
+import type { ChangeState, ChangeStateSnapshot } from './change/types/main.js';
 import { InteractionState, InteractionStateInitOptions, InteractionStateSnapshot } from './interaction/types/main.js';
 import { ViewStateSnapshot } from './view/types/internal.js';
 import { ViewState, ViewStateInitOptions } from './view/types/main.js';

package/dist/wrapper/factory.js

@@ -1,36 +1,12 @@
-import { createActiveTarget } from '../extensions/first-party/active-target/factory.js';
-import { createBoardEvents } from '../extensions/first-party/board-events/factory.js';
-import { createLastMove } from '../extensions/first-party/last-move/factory.js';
-import { createLegalMoves } from '../extensions/first-party/legal-moves/factory.js';
-import { createMainRenderer } from '../extensions/first-party/main-renderer/factory.js';
-import { createSelectedSquare } from '../extensions/first-party/selected-square/factory.js';
-import { DefaultBuiltinChessboardExtensions } from '../extensions/types/wrapper.js';
+import { builtInExtensionFactoryMap, DefaultBuiltinChessboardExtensions } from '../extensions/types/wrapper.js';
 import { createRuntime } from '../runtime/factory/main.js';
-function createBuiltInExtensionDefinition(id) {
-    switch (id) {
-        case 'mainRenderer':
-            return createMainRenderer();
-        case 'events':
-            return createBoardEvents();
-        case 'selectedSquare':
-            return createSelectedSquare();
-        case 'activeTarget':
-            return createActiveTarget();
-        case 'legalMoves':
-            return createLegalMoves();
-        case 'lastMove':
-            return createLastMove();
-        default:
-            throw new Error(`Unknown built-in extension id: ${id}`);
-    }
-}
 export function createBoard(options) {
     // prepare init options for runtime
     const extensionsInput = options.extensions ?? DefaultBuiltinChessboardExtensions;
     const extensions = extensionsInput.map((ext) => {
         if (typeof ext === 'string') {
             // built-in extension, convert to definition
-            return createBuiltInExtensionDefinition(ext);
+            return builtInExtensionFactoryMap[ext]();
         }
         // assume it's already a definition
         return ext;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@mirasen/chessboard",
-	"description": "Mirasen Chessboard — open-source chessboard UI library.",
-	"version": "0.1.1",
+	"description": "Framework-agnostic TypeScript chessboard platform with real chess interaction built in.",
+	"version": "1.0.0",
 	"license": "MIT",
 	"author": {
 		"name": "Mirasen",
@@ -10,10 +10,14 @@
 	"keywords": [
 		"mirasen",
 		"chessboard",
-		"chess-ui",
 		"chess",
+		"chess-ui",
+		"chessboard-ui",
+		"typescript",
+		"framework-agnostic",
 		"svg",
-		"typescript"
+		"extensions",
+		"chessboard-platform"
 	],
 	"homepage": "https://mirasen.io/chessboard",
 	"repository": {
@@ -34,7 +38,11 @@
 			"types": "./dist/extensions/index.d.ts",
 			"import": "./dist/extensions/index.js"
 		},
-		"./unstable/*.js": {
+		"./extensions/build": {
+			"types": "./dist/extensions/build/index.d.ts",
+			"import": "./dist/extensions/build/index.js"
+		},
+		"./unstable/*": {
 			"types": "./dist/*.d.ts",
 			"import": "./dist/*.js"
 		}
@@ -48,11 +56,9 @@
 		"lint": "prettier --check . && eslint .",
 		"check": "tsc --skipLibCheck --noEmit",
 		"check:test": "tsc --project tsconfig-test.json --skipLibCheck --noEmit",
-		"test": "echo 'No tests for now...'",
-		"test-backup": "npm run check:test && vitest run --run",
-		"coverage": "echo 'No tests for now...'",
-		"coverage-backup": "vitest run --coverage",
-		"changeset:version": "changeset version && npm install && git add --all",
+		"test": "npm run check:test && vitest run --run",
+		"coverage": "vitest run --coverage",
+		"changeset:version": "changeset version && npm install && npm run format && git add --all",
 		"changeset:publish": "changeset publish"
 	},
 	"files": [
@@ -87,7 +93,7 @@
 		"vitest": "^4.0.18"
 	},
 	"engines": {
-		"node": ">=22"
+		"node": ">=20"
 	},
 	"dependencies": {
 		"@echecs/fen": "^2.1.0",

package/dist/runtime/factory/ui-move.d.ts

@@ -1,4 +0,0 @@
-import { ExtensionUIMoveRequestContext } from '../../extensions/types/context/ui-move.js';
-import { Square } from '../../state/board/types/internal.js';
-import { MoveDestinationSnapshot } from '../../state/interaction/types/internal.js';
-export declare function createUIMoveRequestContext(sourceSquare: Square, destination: MoveDestinationSnapshot): ExtensionUIMoveRequestContext;

package/dist/runtime/types/ui-move.d.ts

@@ -1,9 +0,0 @@
-import { ExtensionUIMoveRequestStatus } from '../../extensions/types/context/ui-move.js';
-import { MoveRequest, Square } from '../../state/board/types/internal.js';
-import { MoveDestinationSnapshot } from '../../state/interaction/types/internal.js';
-export interface UIMoveRequestContextInternal {
-    readonly sourceSquare: Square;
-    readonly destination: MoveDestinationSnapshot;
-    status: ExtensionUIMoveRequestStatus;
-    resolvedMoveRequest: MoveRequest | null;
-}

package/dist/state/change/types.d.ts

@@ -1,17 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import { ExtensionUIMoveRequestContext, ExtensionUIMoveRequestContextSnapshot } from '../../extensions/types/context/ui-move.js';
-import type { MoveSnapshot } from '../board/types/internal.js';
-import type { ChangeStateMutationSession } from './mutation.js';
-export interface ChangeStateInternal {
-    lastMove: MoveSnapshot | null;
-    deferredUIMoveRequestContext: ExtensionUIMoveRequestContext | null;
-}
-export type ChangeStateSnapshot = ReadonlyDeep<Omit<ChangeStateInternal, 'deferredUIMoveRequestContext'>> & {
-    deferredUIMoveRequestContext: ExtensionUIMoveRequestContextSnapshot | null;
-};
-export interface ChangeState {
-    readonly lastMove: MoveSnapshot | null;
-    setLastMove(move: MoveSnapshot | null, mutationSession: ChangeStateMutationSession): boolean;
-    setDeferredUIMoveRequestContext(context: ExtensionUIMoveRequestContext, mutationSession: ChangeStateMutationSession): boolean;
-    getSnapshot(): ChangeStateSnapshot;
-}