@dxos/plugin-chess 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/src/components/Chessboard/Chessboard.tsx

@@ -0,0 +1,180 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import React, {
+  type PropsWithChildren,
+  forwardRef,
+  useCallback,
+  useContext,
+  useEffect,
+  useImperativeHandle,
+  useMemo,
+  useRef,
+} from 'react';
+
+import { addEventListener } from '@dxos/async';
+import { useObject } from '@dxos/echo-react';
+import { type ThemedClassName } from '@dxos/react-ui';
+import { useSoundEffect } from '@dxos/react-ui-audio';
+import {
+  type ChessModel,
+  Gameboard,
+  type GameboardRootProps,
+  Chessboard as NaturalChessboard,
+  type ChessboardProps as NaturalChessboardProps,
+  getRawPgn,
+  useGameboardContext,
+} from '@dxos/react-ui-gameboard';
+
+import { type Chess } from '#types';
+
+import { Info, type InfoProps } from './Info';
+import { ExtendedChessModel } from './types';
+
+export interface ChessboardController {
+  setMoveNumber(index: number): void;
+}
+
+//
+// Root
+//
+
+type RootProps = PropsWithChildren<{
+  state: Chess.State;
+}>;
+
+const Root = forwardRef<ChessboardController, RootProps>(({ state, children }, forwardedRef) => {
+  const registry = useContext(RegistryContext);
+  const model = useMemo(() => new ExtendedChessModel(registry, state), [registry]);
+  const click = useSoundEffect('Click');
+  const [pgn, updatePgn] = useObject(state, 'pgn');
+
+  // Controller.
+  useImperativeHandle(forwardedRef, () => {
+    return {
+      setMoveNumber: (index) => model.setMoveIndex(index),
+    };
+  }, [model]);
+
+  // TODO(wittjosiah): Rather than useEffect to sync ECHO object to model, create an alternative model implementation.
+  //   This model would take the ECHO object and derive game state directly from that.
+  //   Mutation methods would mutate the ECHO object and other state would be derived from that.
+
+  // External change.
+  // NOTE: Warning if user has not interacted with the board.
+  useEffect(() => {
+    if (model.pgn !== getRawPgn(pgn ?? '')) {
+      const silent = model.pgn === '*';
+      model.update(pgn);
+      if (!silent) {
+        void click.play();
+      }
+    }
+  }, [pgn]);
+
+  // Move.
+  const handleDrop = useCallback<NonNullable<GameboardRootProps<ChessModel>['onDrop']>>(
+    (move) => {
+      if (!model.makeMove(move)) {
+        return false;
+      }
+
+      void click.play();
+      updatePgn(() => model.pgn);
+      return true;
+    },
+    [model],
+  );
+
+  return (
+    <Gameboard.Root model={model} onDrop={handleDrop}>
+      {children}
+    </Gameboard.Root>
+  );
+});
+
+//
+// Content
+//
+
+type Role = 'card--content';
+
+type ContentProps = ThemedClassName<PropsWithChildren<{ role?: Role }>>;
+
+const Content = ({ classNames, children }: ContentProps) => {
+  return (
+    <Gameboard.Content grow contain classNames={classNames}>
+      {children}
+    </Gameboard.Content>
+  );
+};
+
+//
+// Board
+//
+
+const BOARD_NAME = 'Chessboard.Board';
+
+type BoardProps = NaturalChessboardProps;
+
+const Board = (props: BoardProps) => {
+  const registry = useContext(RegistryContext);
+  const { model } = useGameboardContext<ChessModel>(BOARD_NAME);
+
+  // Keyboard navigation.
+  const ref = useRef<HTMLDivElement>(null);
+  useEffect(() => {
+    if (!ref.current) {
+      return;
+    }
+
+    // Participate in keyboard navigation (set tabIndex={0})
+    ref.current.setAttribute('data-arrow-keys', 'all');
+
+    return addEventListener(ref.current, 'keydown', (ev) => {
+      const moveIndex = registry.get(model.moveIndex);
+      switch (ev.key) {
+        case 'ArrowUp':
+          model.setMoveIndex(0);
+          break;
+        case 'ArrowDown':
+          model.setMoveIndex(model.game.history().length);
+          break;
+        case 'ArrowLeft':
+          if (moveIndex > 0) {
+            model.setMoveIndex(moveIndex - 1);
+          }
+          break;
+        case 'ArrowRight':
+          if (moveIndex < model.game.history().length) {
+            model.setMoveIndex(moveIndex + 1);
+          }
+          break;
+      }
+    });
+  }, [registry, model]);
+
+  return <NaturalChessboard {...props} ref={ref} />;
+};
+
+Board.displayName = BOARD_NAME;
+
+//
+// Chessboard
+//
+
+export const Chessboard = {
+  Root: Root,
+  Content: Content,
+  Board: Board,
+  Info: Info,
+};
+
+export type {
+  RootProps as ChessboardRootProps,
+  ContentProps as ChessboardContentProps,
+  BoardProps as ChessboardBoardProps,
+  InfoProps as ChessboardInfoProps,
+};

package/src/components/Chessboard/Info.tsx

@@ -0,0 +1,193 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { useAtomValue } from '@effect-atom/atom-react';
+import React, { type JSX, type PropsWithChildren, useEffect, useMemo, useRef } from 'react';
+
+import { Icon, IconButton, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+import { type Player, useGameboardContext } from '@dxos/react-ui-gameboard';
+import { mx } from '@dxos/ui-theme';
+
+import { meta } from '#meta';
+
+import { type ExtendedChessModel } from './types';
+
+const INFO_NAME = 'Chessboard.Info';
+
+export type InfoProps = ThemedClassName<
+  {
+    orientation?: Player;
+    onOrientationChange?: (orientation: Player) => void;
+    onClose?: () => void;
+  } & Pick<HistoryProps, 'min' | 'max' | 'onSelect'>
+>;
+
+export const Info = ({ classNames, orientation = 'white', onOrientationChange, onClose, ...props }: InfoProps) => {
+  const { t } = useTranslation(meta.id);
+  const { model } = useGameboardContext<ExtendedChessModel>(INFO_NAME);
+
+  return (
+    <div
+      className={mx(
+        'grid grid-rows-[min-content_1fr_min-content] w-full min-w-[18rem] p-2 overflow-hidden bg-group-surface rounded-xs',
+        classNames,
+      )}
+    >
+      <PlayerIndicator
+        model={model}
+        player={orientation === 'white' ? 'black' : 'white'}
+        icon={
+          onClose && (
+            <IconButton
+              variant='ghost'
+              icon='ph--x--regular'
+              iconOnly
+              label={t('close-info.button')}
+              size={4}
+              onClick={onClose}
+            />
+          )
+        }
+      />
+
+      <History model={model} {...props} />
+
+      <PlayerIndicator
+        model={model}
+        player={orientation}
+        icon={
+          onOrientationChange && (
+            <IconButton
+              classNames={mx('transition duration-200 ease-linear', orientation === 'white' && 'rotate-180')}
+              icon='ph--arrows-clockwise--regular'
+              iconOnly
+              label={t('flip-board.button')}
+              size={4}
+              onClick={() => onOrientationChange(orientation === 'white' ? 'black' : 'white')}
+            />
+          )
+        }
+      />
+    </div>
+  );
+};
+
+Info.displayName = INFO_NAME;
+
+//
+// History
+//
+
+type HistoryProps = ThemedClassName<{
+  model: ExtendedChessModel;
+  min?: number;
+  max?: number;
+  onSelect?: (index: number) => void;
+}>;
+
+const History = ({ classNames, model, min, max, onSelect }: HistoryProps) => {
+  const { t } = useTranslation(meta.id);
+  const moveIndex = useAtomValue(model.moveIndex);
+  const label = model.game.isGameOver()
+    ? model.game.isCheckmate()
+      ? t('game.checkmate.label')
+      : model.game.isStalemate()
+        ? t('game.stalemate.label')
+        : t('game.draw.label')
+    : model.game.isCheck()
+      ? t('game.check.label')
+      : undefined;
+
+  const history = model.game.history();
+  const moves = useMemo(
+    () =>
+      history.reduce(
+        (acc, move, index) => {
+          if (index % 2 === 0) {
+            acc.push([{ index, move }]);
+          } else {
+            acc[acc.length - 1].push({ index, move });
+          }
+          return acc;
+        },
+        [] as { index: number; move: string }[][],
+      ),
+    [history.length],
+  );
+
+  const scrollerRef = useRef<HTMLDivElement>(null);
+  useEffect(() => {
+    scrollerRef.current?.scrollTo({ top: scrollerRef.current.scrollHeight });
+  }, [history.length]);
+
+  useEffect(() => {
+    const div = scrollerRef.current?.querySelector(`[data-index="${moveIndex - 1}"]`);
+    scrollerRef.current?.classList.add('scrollbar-none');
+    div?.scrollIntoView({ behavior: 'smooth' });
+    scrollerRef.current?.classList.remove('scrollbar-none');
+  }, [moveIndex]);
+
+  return (
+    <div
+      ref={scrollerRef}
+      className={mx('overflow-y-auto', classNames)}
+      style={{
+        minHeight: min === undefined ? 'auto' : `${min * 24}px`,
+        maxHeight: max === undefined ? 'auto' : `${max * 24}px`,
+      }}
+    >
+      {moves.map(([a, b], index) => (
+        <div key={index} className='grid grid-cols-[3rem_1fr_1fr_1rem] gap-2 ps-4'>
+          <div className='content-center text-xs text-subdued'>{index + 1}</div>
+          {a && (
+            <div
+              data-index={a.index}
+              className={mx('ps-2 text-sm cursor-pointer', a.index === moveIndex - 1 && 'bg-primary-500')}
+              onClick={() => onSelect?.(a.index + 1)}
+            >
+              {a.move}
+            </div>
+          )}
+          {b && (
+            <div
+              data-index={b.index}
+              className={mx('ps-2 text-sm cursor-pointer', b.index === moveIndex - 1 && 'bg-primary-500')}
+              onClick={() => onSelect?.(b.index + 1)}
+            >
+              {b.move}
+            </div>
+          )}
+        </div>
+      ))}
+      {label && <div className='text-center'>{label}</div>}
+    </div>
+  );
+};
+
+//
+// PlayerIndicator
+//
+
+type PlayerIndicatorProps = PropsWithChildren<{
+  model: ExtendedChessModel;
+  player: Player;
+  icon?: JSX.Element;
+}>;
+
+const PlayerIndicator = ({ children, model, player, icon }: PlayerIndicatorProps) => {
+  const turn = player === (model.game.turn() === 'w' ? 'white' : 'black');
+  return (
+    <div className='grid grid-cols-[2rem_1fr_2rem] gap-2 h-(--dx-rail-size) px-1 flex items-center overflow-hidden'>
+      <div className='place-items-center'>
+        <Icon
+          icon={turn ? 'ph--circle--fill' : 'ph--circle--thin'}
+          size={6}
+          classNames={mx(turn && (model.game.isCheckmate() ? 'text-error-500' : 'text-success-text'))}
+        />
+      </div>
+      <div className='truncate overflow-hidden items-center'>{children}</div>
+      {icon}
+    </div>
+  );
+};

package/src/components/Chessboard/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './Chessboard';

package/src/components/Chessboard/types.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Registry } from '@effect-atom/atom-react';
+
+import { ChessModel } from '@dxos/react-ui-gameboard';
+
+import { type Chess } from '#types';
+
+export class ExtendedChessModel extends ChessModel {
+  constructor(
+    registry: Registry.Registry,
+    readonly object: Chess.State,
+  ) {
+    super(registry);
+  }
+}

package/src/components/index.ts

@@ -1,9 +1,5 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
-import { lazy } from 'react';
-
 export * from './Chessboard';
-
-export const ChessboardContainer = lazy(() => import('./ChessboardContainer'));

package/src/containers/ChessArticle/ChessArticle.stories.tsx

@@ -0,0 +1,59 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+
+import { type Obj } from '@dxos/echo';
+import { make as makeGame } from '@dxos/plugin-game';
+import { withClientProvider } from '@dxos/react-client/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '#translations';
+import { Chess } from '#types';
+
+import { ChessArticle } from './ChessArticle';
+
+type DefaultStoryProps = {
+  pgn?: string;
+};
+
+const DefaultStory = ({ pgn }: DefaultStoryProps) => {
+  const { game, state } = useMemo(() => {
+    const state = Chess.make(pgn ? { pgn } : undefined);
+    const game = makeGame({ name: 'Story game', variant: state as Obj.Unknown });
+    return { game, state };
+  }, [pgn]);
+  return <ChessArticle role='article' attendableId='story' game={game} variant={state} />;
+};
+
+const meta = {
+  title: 'plugins/plugin-chess/containers/ChessArticle',
+  component: DefaultStory,
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' }), withClientProvider({ createIdentity: true })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};
+
+export const EndGame: Story = {
+  args: {
+    pgn: '1. e4 e5 2. Nf3 Nc6 3. Bc4 Bc5 4. c3 Nf6 5. d4 exd4 6. cxd4 Bb4+ 7. Nc3 d5 8. exd5 Nxd5 9. O-O Be6 10. Qb3 Na5 11. Qa4+ c6 12. Bxd5 Bxc3 13. Bxe6 fxe6 *',
+  },
+};
+
+export const Promption: Story = {
+  args: {
+    pgn: '1. e4 e5 2. Nf3 Nc6 3. Bc4 Bc5 4. c3 Nf6 5. d4 exd4 6. cxd4 Bb4+ 7. Nc3 d5 8. exd5 Nxd5 9. O-O Be6 10. Qb3 Na5 11. Qa4+ c6 12. Bxd5 Bxc3 13. Bxe6 fxe6 14. d5 Qg5 15. dxe6 Qg4 16. e7 Kf7 17. bxc3 Kg6 *',
+  },
+};

package/src/containers/ChessArticle/ChessArticle.tsx

@@ -0,0 +1,108 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Chess as ChessJS } from 'chess.js';
+import React, { useCallback, useRef, useState } from 'react';
+
+import { Obj } from '@dxos/echo';
+import { type GameVariantSurfaceProps } from '@dxos/plugin-game/types';
+import { Panel, Toolbar, useTranslation } from '@dxos/react-ui';
+import { type Player } from '@dxos/react-ui-gameboard';
+import { mx } from '@dxos/ui-theme';
+
+import { Chessboard, type ChessboardController, type ChessboardInfoProps } from '#components';
+import { meta } from '#meta';
+import { Chess } from '#types';
+
+export type ChessArticleProps = GameVariantSurfaceProps;
+
+export const ChessArticle = ({ role, variant }: ChessArticleProps) => {
+  const { t } = useTranslation(meta.id);
+  const [orientation, setOrientation] = useState<Player>('white');
+  const [showInfo, setShowInfo] = useState(true);
+  const controller = useRef<ChessboardController>(null);
+
+  const handleSelect = useCallback<NonNullable<ChessboardInfoProps['onSelect']>>((index) => {
+    controller.current?.setMoveNumber(index);
+  }, []);
+
+  const isGameOver = (() => {
+    if (!Obj.instanceOf(Chess.State, variant) || (!variant.pgn && !variant.fen)) {
+      return false;
+    }
+    try {
+      const chess = new ChessJS();
+      if (variant.pgn) {
+        chess.loadPgn(variant.pgn);
+      } else if (variant.fen) {
+        chess.load(variant.fen);
+      }
+      return chess.isGameOver();
+    } catch {
+      return false;
+    }
+  })();
+
+  const handleNewGame = useCallback(() => {
+    if (!Obj.instanceOf(Chess.State, variant)) {
+      return;
+    }
+    Obj.update(variant, (variant) => {
+      const mutable = variant as Obj.Mutable<typeof variant>;
+      mutable.pgn = undefined;
+      mutable.fen = undefined;
+    });
+  }, [variant]);
+
+  if (!Obj.instanceOf(Chess.State, variant)) {
+    return null;
+  }
+
+  return (
+    <Chessboard.Root state={variant} ref={controller}>
+      <Panel.Root role={role} classNames='@container'>
+        <Panel.Toolbar asChild>
+          <Toolbar.Root>
+            {isGameOver && <Toolbar.Button onClick={handleNewGame}>{t('new-game.button')}</Toolbar.Button>}
+            <div className='grow' />
+            <Toolbar.IconButton
+              icon='ph--info--regular'
+              iconOnly
+              label={t('toggle-info.button')}
+              classNames={mx('invisible @4xl:visible')}
+              onClick={() => setShowInfo((open) => !open)}
+            />
+          </Toolbar.Root>
+        </Panel.Toolbar>
+        <Panel.Content>
+          <div
+            className={mx(
+              'grid h-full w-full',
+              showInfo && '@4xl:grid-cols-[1fr_320px] gap-8',
+              role === 'article' && 'p-4',
+              role === 'section' && 'aspect-square',
+              role === 'section' && showInfo && '@4xl:aspect-auto',
+            )}
+          >
+            <Chessboard.Content>
+              <Chessboard.Board classNames='border rounded-xs' orientation={orientation} />
+            </Chessboard.Content>
+            {showInfo && (
+              <div className='hidden @4xl:flex flex-col justify-center items-center overflow-hidden'>
+                <Chessboard.Info
+                  orientation={orientation}
+                  min={8}
+                  max={8}
+                  onOrientationChange={setOrientation}
+                  onClose={() => setShowInfo(false)}
+                  onSelect={handleSelect}
+                />
+              </div>
+            )}
+          </div>
+        </Panel.Content>
+      </Panel.Root>
+    </Chessboard.Root>
+  );
+};

package/src/containers/ChessArticle/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+export { ChessArticle as default } from './ChessArticle';

package/src/containers/ChessCard/ChessCard.stories.tsx

@@ -0,0 +1,47 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+
+import { make as makeGame } from '@dxos/plugin-game';
+import { CardContainer } from '@dxos/react-ui-mosaic/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { meta as pluginMeta } from '#meta';
+import { Chess } from '#types';
+
+import { ChessCard } from './ChessCard';
+
+const SAMPLE_PGN =
+  '1. e4 e5 2. Nf3 Nc6 3. Bc4 Bc5 4. c3 Nf6 5. d4 exd4 6. cxd4 Bb4+ 7. Nc3 d5 8. exd5 Nxd5 9. O-O Be6 10. Qb3 Na5 11. Qa4+ c6 12. Bxd5 Bxc3 13. Bxe6 fxe6 14. d5 Qg5 15. dxe6 Qg4 16. e7 Kf7 17. bxc3 Kg6 *';
+
+const CardStory = () => {
+  const { game, state } = useMemo(() => {
+    const state = Chess.make({ pgn: SAMPLE_PGN });
+    const game = makeGame({ name: 'Story game', variant: state });
+    return { game, state };
+  }, []);
+  return (
+    <CardContainer role='popover' icon={pluginMeta.icon}>
+      <ChessCard role='card--content' game={game} variant={state} />
+    </CardContainer>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-chess/containers/ChessCard',
+  render: () => <CardStory />,
+  decorators: [withTheme(), withLayout({ layout: 'column' })],
+  parameters: {
+    layout: 'fullscreen',
+  },
+  tags: ['cards'],
+} satisfies Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Popover: Story = {};

package/src/containers/ChessCard/ChessCard.tsx

@@ -0,0 +1,27 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { Obj } from '@dxos/echo';
+import { type GameVariantSurfaceProps } from '@dxos/plugin-game/types';
+
+import { Chessboard } from '#components';
+import { Chess } from '#types';
+
+export type ChessCardProps = GameVariantSurfaceProps;
+
+export const ChessCard = ({ variant }: ChessCardProps) => {
+  if (!Obj.instanceOf(Chess.State, variant)) {
+    return null;
+  }
+
+  return (
+    <Chessboard.Root state={variant}>
+      <Chessboard.Content>
+        <Chessboard.Board />
+      </Chessboard.Content>
+    </Chessboard.Root>
+  );
+};

package/src/containers/ChessCard/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+export { ChessCard as default } from './ChessCard';

package/src/containers/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const ChessArticle: ComponentType<any> = lazy(() => import('./ChessArticle'));
+export const ChessCard: ComponentType<any> = lazy(() => import('./ChessCard'));

package/src/index.ts

@@ -2,10 +2,6 @@
 // Copyright 2023 DXOS.org
 //
 
-export * from './capabilities';
-export * from './components';
-export * from './functions';
+export * from './blueprints';
 export * from './meta';
 export * from './types';
-
-export * from './ChessPlugin';