@dxos/plugin-chess 0.8.4-main.1068cf700f → 0.8.4-main.1c7ec43d41

package/src/components/{Chessboard.tsx → Chessboard/Chessboard.tsx}

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type Registry, RegistryContext } from '@effect-atom/atom-react';
+import { RegistryContext } from '@effect-atom/atom-react';
 import React, {
   type PropsWithChildren,
   forwardRef,
@@ -15,10 +15,10 @@ import React, {
 } from 'react';
 
 import { addEventListener } from '@dxos/async';
-import { Obj } from '@dxos/echo';
+import { useObject } from '@dxos/echo-react';
 import { type ThemedClassName } from '@dxos/react-ui';
 import {
-  ChessModel,
+  type ChessModel,
   Gameboard,
   type GameboardRootProps,
   Chessboard as NaturalChessboard,
@@ -27,37 +27,29 @@ import {
   useGameboardContext,
 } from '@dxos/react-ui-gameboard';
 import { useSoundEffect } from '@dxos/react-ui-sfx';
-import { mx } from '@dxos/ui-theme';
 
-import { type Chess } from '../types';
+import { type Chess } from '#types';
 
 import { Info, type InfoProps } from './Info';
+import { ExtendedChessModel } from './types';
 
 export interface ChessboardController {
   setMoveNumber(index: number): void;
 }
 
-export class ExtendedChessModel extends ChessModel {
-  constructor(
-    registry: Registry.Registry,
-    readonly object: Chess.Game,
-  ) {
-    super(registry);
-  }
-}
-
 //
 // Root
 //
 
 type RootProps = PropsWithChildren<{
-  game: Chess.Game;
+  state: Chess.State;
 }>;
 
-const Root = forwardRef<ChessboardController, RootProps>(({ game, children }, forwardedRef) => {
+const Root = forwardRef<ChessboardController, RootProps>(({ state, children }, forwardedRef) => {
   const registry = useContext(RegistryContext);
-  const model = useMemo(() => new ExtendedChessModel(registry, game), [registry]);
+  const model = useMemo(() => new ExtendedChessModel(registry, state), [registry]);
   const click = useSoundEffect('Click');
+  const [pgn, updatePgn] = useObject(state, 'pgn');
 
   // Controller.
   useImperativeHandle(forwardedRef, () => {
@@ -66,17 +58,21 @@ const Root = forwardRef<ChessboardController, RootProps>(({ game, children }, fo
     };
   }, [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(game.pgn ?? '')) {
+    if (model.pgn !== getRawPgn(pgn ?? '')) {
       const silent = model.pgn === '*';
-      model.update(game.pgn);
+      model.update(pgn);
       if (!silent) {
         void click.play();
       }
     }
-  }, [game.pgn]);
+  }, [pgn]);
 
   // Move.
   const handleDrop = useCallback<NonNullable<GameboardRootProps<ChessModel>['onDrop']>>(
@@ -86,9 +82,7 @@ const Root = forwardRef<ChessboardController, RootProps>(({ game, children }, fo
       }
 
       void click.play();
-      Obj.change(game, (g) => {
-        g.pgn = model.pgn;
-      });
+      updatePgn(() => model.pgn);
       return true;
     },
     [model],
@@ -105,17 +99,13 @@ const Root = forwardRef<ChessboardController, RootProps>(({ game, children }, fo
 // Content
 //
 
-type Role = 'card--popover' | 'card--intrinsic' | 'card--extrinsic';
+type Role = 'card--content';
 
 type ContentProps = ThemedClassName<PropsWithChildren<{ role?: Role }>>;
 
-const Content = ({ classNames, children, role }: ContentProps) => {
+const Content = ({ classNames, children }: ContentProps) => {
   return (
-    <Gameboard.Content
-      classNames={mx(classNames, role === 'card--popover' && 'size-container card-square')}
-      grow={!role || role === 'card--extrinsic'}
-      contain={!role || role === 'card--extrinsic' || role === 'card--popover'}
-    >
+    <Gameboard.Content grow contain classNames={classNames}>
       {children}
     </Gameboard.Content>
   );
@@ -166,7 +156,7 @@ const Board = (props: BoardProps) => {
     });
   }, [registry, model]);
 
-  return <NaturalChessboard ref={ref} {...props} />;
+  return <NaturalChessboard {...props} ref={ref} />;
 };
 
 Board.displayName = BOARD_NAME;

package/src/components/{Info.tsx → Chessboard/Info.tsx}

@@ -5,16 +5,13 @@
 import { useAtomValue } from '@effect-atom/atom-react';
 import React, { type JSX, type PropsWithChildren, useEffect, useMemo, useRef } from 'react';
 
-import { generateName } from '@dxos/display-name';
-import { Obj } from '@dxos/echo';
-import { type SpaceMember, useMembers } from '@dxos/react-client/echo';
-import { Icon, IconButton, Select, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+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 { meta } from '#meta';
 
-import { type ExtendedChessModel } from './Chessboard';
+import { type ExtendedChessModel } from './types';
 
 const INFO_NAME = 'Chessboard.Info';
 
@@ -29,13 +26,11 @@ export type InfoProps = ThemedClassName<
 export const Info = ({ classNames, orientation = 'white', onOrientationChange, onClose, ...props }: InfoProps) => {
   const { t } = useTranslation(meta.id);
   const { model } = useGameboardContext<ExtendedChessModel>(INFO_NAME);
-  const db = Obj.getDatabase(model.object);
-  const members = useMembers(db?.spaceId);
 
   return (
     <div
       className={mx(
-        'grid grid-rows-[min-content_1fr_min-content] is-full min-is-[18rem] p-2 overflow-hidden bg-groupSurface rounded-sm',
+        'grid grid-rows-[min-content_1fr_min-content] w-full min-w-[18rem] p-2 overflow-hidden bg-group-surface rounded-xs',
         classNames,
       )}
     >
@@ -44,20 +39,17 @@ export const Info = ({ classNames, orientation = 'white', onOrientationChange, o
         player={orientation === 'white' ? 'black' : 'white'}
         icon={
           onClose && (
-            <IconButton icon='ph--x--regular' iconOnly label={t('close info button')} size={4} onClick={onClose} />
+            <IconButton
+              variant='ghost'
+              icon='ph--x--regular'
+              iconOnly
+              label={t('close-info.button')}
+              size={4}
+              onClick={onClose}
+            />
           )
         }
-      >
-        <PlayerSelector
-          value={model.object.players?.[orientation === 'white' ? 'black' : 'white']}
-          onValueChange={(value) => {
-            Obj.change(model.object, (obj) => {
-              obj.players![orientation === 'white' ? 'black' : 'white'] = value;
-            });
-          }}
-          members={members}
-        />
-      </PlayerIndicator>
+      />
 
       <History model={model} {...props} />
 
@@ -70,23 +62,13 @@ export const Info = ({ classNames, orientation = 'white', onOrientationChange, o
               classNames={mx('transition duration-200 ease-linear', orientation === 'white' && 'rotate-180')}
               icon='ph--arrows-clockwise--regular'
               iconOnly
-              label={t('flip board button')}
+              label={t('flip-board.button')}
               size={4}
               onClick={() => onOrientationChange(orientation === 'white' ? 'black' : 'white')}
             />
           )
         }
-      >
-        <PlayerSelector
-          value={model.object.players?.[orientation]}
-          onValueChange={(value) => {
-            Obj.change(model.object, (obj) => {
-              obj.players![orientation] = value;
-            });
-          }}
-          members={members}
-        />
-      </PlayerIndicator>
+      />
     </div>
   );
 };
@@ -109,12 +91,12 @@ const History = ({ classNames, model, min, max, onSelect }: HistoryProps) => {
   const moveIndex = useAtomValue(model.moveIndex);
   const label = model.game.isGameOver()
     ? model.game.isCheckmate()
-      ? t('game.checkmate label')
+      ? t('game.checkmate.label')
       : model.game.isStalemate()
-        ? t('game.stalemate label')
-        : t('game.draw label')
+        ? t('game.stalemate.label')
+        : t('game.draw.label')
     : model.game.isCheck()
-      ? t('game.check label')
+      ? t('game.check.label')
       : undefined;
 
   const history = model.game.history();
@@ -156,12 +138,12 @@ const History = ({ classNames, model, min, max, onSelect }: HistoryProps) => {
       }}
     >
       {moves.map(([a, b], index) => (
-        <div key={index} className='grid grid-cols-[3rem_1fr_1fr_1rem] gap-2 pis-4 leading-1'>
+        <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('pis-2 cursor-pointer', a.index === moveIndex - 1 && 'bg-primary-500')}
+              className={mx('ps-2 text-sm cursor-pointer', a.index === moveIndex - 1 && 'bg-primary-500')}
               onClick={() => onSelect?.(a.index + 1)}
             >
               {a.move}
@@ -170,7 +152,7 @@ const History = ({ classNames, model, min, max, onSelect }: HistoryProps) => {
           {b && (
             <div
               data-index={b.index}
-              className={mx('pis-2 cursor-pointer', b.index === moveIndex - 1 && 'bg-primary-500')}
+              className={mx('ps-2 text-sm cursor-pointer', b.index === moveIndex - 1 && 'bg-primary-500')}
               onClick={() => onSelect?.(b.index + 1)}
             >
               {b.move}
@@ -196,12 +178,12 @@ type PlayerIndicatorProps = PropsWithChildren<{
 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 bs-[--rail-size] pli-1 flex items-center overflow-hidden'>
+    <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-red-500' : 'text-green-500'))}
+          classNames={mx(turn && (model.game.isCheckmate() ? 'text-error-500' : 'text-success-text'))}
         />
       </div>
       <div className='truncate overflow-hidden items-center'>{children}</div>
@@ -209,38 +191,3 @@ const PlayerIndicator = ({ children, model, player, icon }: PlayerIndicatorProps
     </div>
   );
 };
-
-//
-// PlayerSelector
-//
-
-type PlayerSelectorProps = {
-  value?: string;
-  onValueChange: (player: string) => void;
-  members: SpaceMember[];
-};
-
-const PlayerSelector = ({ value, onValueChange, members }: PlayerSelectorProps) => {
-  const { t } = useTranslation(meta.id);
-  return (
-    <Select.Root value={value} onValueChange={onValueChange}>
-      <Select.TriggerButton placeholder={t('select player button')} />
-      <Select.Portal>
-        <Select.Content>
-          <Select.Viewport>
-            {members.map((member) => {
-              const memberKey = member.identity.identityKey.toHex();
-              const displayName = member.identity?.profile?.displayName || generateName(memberKey);
-              return (
-                <Select.Option key={memberKey} value={memberKey}>
-                  {displayName}
-                </Select.Option>
-              );
-            })}
-          </Select.Viewport>
-          <Select.Arrow />
-        </Select.Content>
-      </Select.Portal>
-    </Select.Root>
-  );
-};

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/{components/Chessboard.stories.tsx → containers/ChessArticle/ChessArticle.stories.tsx}

@@ -5,27 +5,33 @@
 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/types';
 import { withClientProvider } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/react-ui/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
-import { translations } from '../translations';
-import { Chess } from '../types';
+import { translations } from '#translations';
+import { Chess } from '#types';
 
-import { ChessboardArticle } from './ChessboardArticle';
+import { ChessArticle } from './ChessArticle';
 
-type StoryProps = {
+type DefaultStoryProps = {
   pgn?: string;
 };
 
-const DefaultStory = ({ pgn }: StoryProps) => {
-  const game = useMemo(() => Chess.make(pgn ? { pgn } : undefined), [pgn]);
-  return <ChessboardArticle subject={game} />;
+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/Chessboard',
+  title: 'plugins/plugin-chess/containers/ChessArticle',
   component: DefaultStory,
-  decorators: [withTheme(), withClientProvider({ createIdentity: true })],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' }), withClientProvider({ createIdentity: true })],
   parameters: {
     layout: 'fullscreen',
     translations,

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/types';
+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,12 @@
 // Copyright 2023 DXOS.org
 //
 
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
 export * from './blueprints';
-export * from './capabilities';
-export * from './components';
 export * from './meta';
 export * from './types';
 
-export * from './ChessPlugin';
+export const ChessPlugin = Plugin.lazy(meta, () => import('#plugin'));

package/src/meta.ts

@@ -6,7 +6,7 @@ import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
 export const meta: Plugin.Meta = {
-  id: 'dxos.org/plugin/chess',
+  id: 'org.dxos.plugin.chess',
   name: 'Chess',
   description: trim`
     Full-featured chess game supporting multiplayer matches with friends or practice sessions against AI opponents.