@dxos/plugin-chess 0.8.4-main.c85a9c8dae → 0.8.4-main.d9fc60f731

package/src/components/Chessboard/Info.tsx

@@ -5,14 +5,11 @@
 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 './types';
 
@@ -29,8 +26,6 @@ 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
@@ -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 ps-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('ps-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('ps-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}
@@ -201,7 +183,7 @@ const PlayerIndicator = ({ children, model, player, icon }: PlayerIndicatorProps
         <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/types.ts

@@ -6,12 +6,12 @@ import { type Registry } from '@effect-atom/atom-react';
 
 import { ChessModel } from '@dxos/react-ui-gameboard';
 
-import { type Chess } from '../../types';
+import { type Chess } from '#types';
 
 export class ExtendedChessModel extends ChessModel {
   constructor(
     registry: Registry.Registry,
-    readonly object: Chess.Game,
+    readonly object: Chess.State,
   ) {
     super(registry);
   }

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

@@ -5,21 +5,27 @@
 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 { translations } from '#translations';
+import { Chess } from '#types';
 
 import { ChessArticle } from './ChessArticle';
 
-type StoryProps = {
+type DefaultStoryProps = {
   pgn?: string;
 };
 
-const DefaultStory = ({ pgn }: StoryProps) => {
-  const game = useMemo(() => Chess.make(pgn ? { pgn } : undefined), [pgn]);
-  return <ChessArticle 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 = {

package/src/containers/ChessArticle/ChessArticle.tsx

@@ -2,64 +2,100 @@
 // Copyright 2024 DXOS.org
 //
 
+import { Chess as ChessJS } from 'chess.js';
 import React, { useCallback, useRef, useState } from 'react';
 
-import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { type GameVariantSurfaceProps } from '@dxos/plugin-game';
 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 { type Chess } from '../../types';
+import { Chessboard, type ChessboardController, type ChessboardInfoProps } from '#components';
+import { meta } from '#meta';
+import { Chess } from '#types';
 
-export type ChessArticleProps = SurfaceComponentProps<Chess.Game>;
+export type ChessArticleProps = GameVariantSurfaceProps;
 
-export const ChessArticle = ({ role, subject: game }: ChessArticleProps) => {
+export const ChessArticle = ({ role, variant }: ChessArticleProps) => {
   const { t } = useTranslation(meta.id);
   const [orientation, setOrientation] = useState<Player>('white');
-  const [open, setOpen] = useState(true);
+  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 game={game} ref={controller}>
+    <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')}
-              disabled={open}
-              classNames={mx('invisible @3xl:visible')}
-              onClick={() => setOpen((open) => !open)}
+              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 gap-2',
-              open && '@3xl:grid-cols-[1fr_320px]',
+              'grid h-full w-full',
+              showInfo && '@4xl:grid-cols-[1fr_320px] gap-8',
+              role === 'article' && 'p-4',
               role === 'section' && 'aspect-square',
-              role === 'section' && open && '@3xl:aspect-auto',
+              role === 'section' && showInfo && '@4xl:aspect-auto',
             )}
           >
             <Chessboard.Content>
-              <Chessboard.Board classNames='m-4 rounded-xs overflow-hidden' orientation={orientation} />
+              <Chessboard.Board classNames='border rounded-xs' orientation={orientation} />
             </Chessboard.Content>
-            {open && (
-              <div className='hidden @3xl:flex flex-col p-8 justify-center items-center overflow-hidden'>
+            {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={() => setOpen(false)}
+                  onClose={() => setShowInfo(false)}
                   onSelect={handleSelect}
                 />
               </div>

package/src/containers/ChessArticle/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2026 DXOS.org
 //
 
-import { ChessArticle } from './ChessArticle';
-
-export default ChessArticle;
+export { ChessArticle as default } from './ChessArticle';

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

@@ -5,11 +5,12 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo } from 'react';
 
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
+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 { meta as pluginMeta } from '#meta';
+import { Chess } from '#types';
 
 import { ChessCard } from './ChessCard';
 
@@ -17,10 +18,14 @@ 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 = useMemo(() => Chess.make({ pgn: SAMPLE_PGN }), []);
+  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 subject={game} />
+      <ChessCard role='card--content' game={game} variant={state} />
     </CardContainer>
   );
 };

package/src/containers/ChessCard/ChessCard.tsx

@@ -4,16 +4,21 @@
 
 import React from 'react';
 
-import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { type GameVariantSurfaceProps } from '@dxos/plugin-game';
 
-import { Chessboard } from '../../components';
-import { type Chess } from '../../types';
+import { Chessboard } from '#components';
+import { Chess } from '#types';
 
-export type ChessCardProps = SurfaceComponentProps<Chess.Game>;
+export type ChessCardProps = GameVariantSurfaceProps;
+
+export const ChessCard = ({ variant }: ChessCardProps) => {
+  if (!Obj.instanceOf(Chess.State, variant)) {
+    return null;
+  }
 
-export const ChessCard = ({ subject: game }: ChessCardProps) => {
   return (
-    <Chessboard.Root game={game}>
+    <Chessboard.Root state={variant}>
       <Chessboard.Content>
         <Chessboard.Board />
       </Chessboard.Content>

package/src/containers/ChessCard/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2026 DXOS.org
 //
 
-import { ChessCard } from './ChessCard';
-
-export default ChessCard;
+export { ChessCard as default } from './ChessCard';

package/src/index.ts

@@ -3,9 +3,5 @@
 //
 
 export * from './blueprints';
-export * from './capabilities';
-export * from './components/Chessboard';
 export * from './meta';
 export * from './types';
-
-export * from './ChessPlugin';

package/src/meta.ts

@@ -2,12 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Plugin } from '@dxos/app-framework';
+import { Plugin } from '@dxos/app-framework';
+import { DXN } from '@dxos/keys';
+import { meta as gameMeta } from '@dxos/plugin-game';
 import { trim } from '@dxos/util';
 
-export const meta: Plugin.Meta = {
-  id: 'dxos.org/plugin/chess',
+export const meta = Plugin.makeMeta({
+  key: DXN.make('org.dxos.plugin.chess'),
   name: 'Chess',
+  author: 'DXOS',
   description: trim`
     Full-featured chess game supporting multiplayer matches with friends or practice sessions against AI opponents.
     Track game history and analyze moves in real-time.
@@ -15,5 +18,8 @@ export const meta: Plugin.Meta = {
   icon: 'ph--shield-chevron--regular',
   iconHue: 'amber',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-chess',
+  spec: 'PLUGIN.mdl',
   screenshots: ['https://dxos.network/plugin-details-chess-dark.png'],
-};
+  dependsOn: [gameMeta.id],
+  tags: ['game'],
+});

package/src/operations/index.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/compute';
+
+export const ChessOperationHandlerSet = OperationHandlerSet.lazy(
+  () => import('./move'),
+  () => import('./play'),
+  () => import('./print'),
+);

package/src/operations/move.ts

@@ -0,0 +1,36 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Chess as ChessJS } from 'chess.js';
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { loadGame } from '@dxos/plugin-game';
+
+import { Chess, ChessOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof ChessOperation.Move> = ChessOperation.Move.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ game, move }) {
+      const { variant } = yield* loadGame(game, Chess.State);
+      const chess = new ChessJS();
+      if (variant.pgn) {
+        chess.loadPgn(variant.pgn);
+      } else if (variant.fen) {
+        chess.load(variant.fen);
+      }
+
+      chess.move(move, { strict: false });
+      const pgn = chess.pgn();
+      Obj.update(variant, (variant) => {
+        const mutable = variant as Obj.Mutable<typeof variant>;
+        mutable.pgn = pgn;
+      });
+      return { pgn };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/play.ts

@@ -0,0 +1,45 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Chess as ChessJS } from 'chess.js';
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { loadGame } from '@dxos/plugin-game';
+
+import { Chess, ChessOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof ChessOperation.Play> = ChessOperation.Play.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ game, side = 'any' }) {
+      const { variant } = yield* loadGame(game, Chess.State);
+      const chess = new ChessJS();
+      if (variant.pgn) {
+        chess.loadPgn(variant.pgn);
+      } else if (variant.fen) {
+        chess.load(variant.fen);
+      }
+
+      if (
+        !(side === 'any' || (chess.turn() === 'w' && side === 'white') || (chess.turn() === 'b' && side === 'black'))
+      ) {
+        return { move: undefined, pgn: variant.pgn ?? '' };
+      }
+
+      const moves = chess.moves();
+      const move = moves[Math.floor(Math.random() * moves.length)];
+
+      chess.move(move, { strict: false });
+      const pgn = chess.pgn();
+      Obj.update(variant, (variant) => {
+        const mutable = variant as Obj.Mutable<typeof variant>;
+        mutable.pgn = pgn;
+      });
+      return { move, pgn };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/print.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Chess as ChessJS } from 'chess.js';
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+
+import { ChessOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof ChessOperation.Print> = ChessOperation.Print.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ pgn, fen }) {
+      try {
+        const chess = new ChessJS(fen);
+        if (pgn) {
+          chess.loadPgn(pgn);
+        }
+        return { ascii: chess.ascii() };
+      } catch {
+        return { ascii: '' };
+      }
+    }),
+  ),
+);
+
+export default handler;

package/src/plugin.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const ChessPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
+export { ChessOperationHandlerSet } from './operations';

package/src/testing.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// Eager re-export of `ChessPlugin`. See `@dxos/plugin-testing/src/core.ts`
+// for the rationale.
+export * from './ChessPlugin';

package/src/translations.ts

@@ -2,35 +2,33 @@
 // Copyright 2023 DXOS.org
 //
 
+import { Type } from '@dxos/echo';
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
-import { Chess } from './types';
+import { meta } from '#meta';
+import { Chess } from '#types';
 
 export const translations = [
   {
     'en-US': {
-      [Chess.Game.typename]: {
-        'typename label': 'Game',
-        'typename label_zero': 'Games',
-        'typename label_one': 'Game',
-        'typename label_other': 'Games',
-        'object name placeholder': 'New game',
-        'rename object label': 'Rename game',
-        'delete object label': 'Delete game',
-        'object deleted label': 'Game deleted',
+      [Type.getTypename(Chess.State)]: {
+        'typename.label': 'Chess',
+        'typename.label_zero': 'Chess games',
+        'typename.label_one': 'Chess game',
+        'typename.label_other': 'Chess games',
       },
       [meta.id]: {
-        'plugin name': 'Chess',
-        'delete game label': 'Delete',
-        'game.checkmate label': 'Checkmate',
-        'game.stalemate label': 'Stalemate',
-        'game.draw label': 'Draw',
-        'game.check label': 'Check',
-        'select player button': 'Select player',
-        'toggle info button': 'Toggle info',
-        'close info button': 'Close info',
-        'flip board button': 'Flip board',
+        'plugin.name': 'Chess',
+        'new-game.button': 'New game',
+        'delete-game.label': 'Delete',
+        'game.checkmate.label': 'Checkmate',
+        'game.stalemate.label': 'Stalemate',
+        'game.draw.label': 'Draw',
+        'game.check.label': 'Check',
+        'select-player.button': 'Select player',
+        'toggle-info.button': 'Toggle info',
+        'close-info.button': 'Close info',
+        'flip-board.button': 'Flip board',
       },
     },
   },