@dxos/plugin-chess 0.8.4-main.1da679c → 0.8.4-main.21d9917

package/src/capabilities/react-surface/react-surface.tsx

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capability, Common } from '@dxos/app-framework';
+import { Obj } from '@dxos/echo';
+
+import { ChessboardContainer } from '../../components';
+import { meta } from '../../meta';
+import { Chess } from '../../types';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Common.Capability.ReactSurface, [
+      Common.createSurface({
+        id: meta.id,
+        role: ['article', 'section', 'card--content'],
+        // TODO(burdon): Could this be standardized so that we don't require a subject property.
+        filter: (data): data is { subject: Chess.Game } => Obj.instanceOf(Chess.Game, data.subject),
+        component: ({ data, role }) => <ChessboardContainer role={role} subject={data.subject} />,
+      }),
+    ]),
+  ),
+);

package/src/cli/index.ts

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

package/src/cli/plugin.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Common, Plugin } from '@dxos/app-framework';
+import { type CreateObject } from '@dxos/plugin-space/types';
+
+import { meta } from '../meta';
+import { Chess } from '../types';
+
+// TODO(wittjosiah): Factor out shared modules.
+export const ChessPlugin = Plugin.define(meta).pipe(
+  Common.Plugin.addSchemaModule({ schema: [Chess.Game] }),
+  Common.Plugin.addMetadataModule({
+    metadata: {
+      id: Chess.Game.typename,
+      metadata: {
+        createObject: ((props) => Effect.sync(() => Chess.make(props))) satisfies CreateObject,
+        addToCollectionOnCreate: true,
+      },
+    },
+  }),
+  Plugin.make,
+);

package/src/components/Card.stories.tsx

@@ -2,67 +2,46 @@
 // Copyright 2025 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
+import React, { useMemo } from 'react';
 
-import { CardContainer } from '@dxos/react-ui-stack/testing';
-import { withTheme } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
+import { CardContainer } from '@dxos/react-ui-mosaic/testing';
 
 import { meta as pluginMeta } from '../meta';
 import { Chess } from '../types';
 
 import { Chessboard } from './Chessboard';
 
-type DefaultStoryProps = {
-  role: 'card--popover' | 'card--intrinsic' | 'card--extrinsic';
-  game: Chess.Game;
-};
+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 meta: Meta<DefaultStoryProps> = {
-  title: 'plugins/plugin-chess/Card',
-  render: ({ role, game }) => (
-    <CardContainer icon={pluginMeta.icon} role={role}>
+// TODO(wittjosiah): ECHO objects don't work when passed via Storybook args.
+const CardStory = () => {
+  const game = useMemo(() => Chess.make({ pgn: SAMPLE_PGN }), []);
+  return (
+    <CardContainer icon={pluginMeta.icon}>
       <Chessboard.Root game={game}>
-        <Chessboard.Content role={role}>
+        <Chessboard.Content>
           <Chessboard.Board />
         </Chessboard.Content>
       </Chessboard.Root>
     </CardContainer>
-  ),
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-chess/Card',
+  render: () => <CardStory />,
   decorators: [withTheme],
   parameters: {
     layout: 'centered',
   },
   tags: ['cards'],
-};
+} satisfies Meta;
 
 export default meta;
 
-const game = Chess.makeGame({
-  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 *',
-});
-
 type Story = StoryObj<typeof meta>;
 
-export const Popover: Story = {
-  args: {
-    role: 'card--popover',
-    game: game,
-  },
-};
-
-export const Intrinsic: Story = {
-  args: {
-    role: 'card--intrinsic',
-    game: game,
-  },
-};
-
-export const Extrinsic: Story = {
-  args: {
-    role: 'card--extrinsic',
-    game: game,
-  },
-};
+export const Popover: Story = {};

package/src/components/Chessboard.stories.tsx

@@ -2,49 +2,52 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
 
 import { withClientProvider } from '@dxos/react-client/testing';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
 import { translations } from '../translations';
 import { Chess } from '../types';
 
 import { ChessboardArticle } from './ChessboardArticle';
 
+type StoryProps = {
+  pgn?: string;
+};
+
+const DefaultStory = ({ pgn }: StoryProps) => {
+  const game = useMemo(() => Chess.make(pgn ? { pgn } : undefined), [pgn]);
+  return <ChessboardArticle subject={game} />;
+};
+
 const meta = {
   title: 'plugins/plugin-chess/Chessboard',
-  component: ChessboardArticle,
-  decorators: [withClientProvider({ createIdentity: true }), withTheme, withLayout({ fullscreen: true })],
+  component: DefaultStory,
+  decorators: [withTheme, withClientProvider({ createIdentity: true })],
   parameters: {
+    layout: 'fullscreen',
     translations,
   },
-} satisfies Meta<typeof ChessboardArticle>;
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
 type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
-  args: {
-    game: Chess.makeGame(),
-  },
+  args: {},
 };
 
 export const EndGame: Story = {
   args: {
-    game: Chess.makeGame({
-      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 *',
-    }),
+    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: {
-    game: Chess.makeGame({
-      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 *',
-    }),
+    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/components/Chessboard.tsx

@@ -2,10 +2,12 @@
 // Copyright 2024 DXOS.org
 //
 
+import { type Registry, RegistryContext } from '@effect-atom/atom-react';
 import React, {
   type PropsWithChildren,
   forwardRef,
   useCallback,
+  useContext,
   useEffect,
   useImperativeHandle,
   useMemo,
@@ -13,6 +15,7 @@ import React, {
 } from 'react';
 
 import { addEventListener } from '@dxos/async';
+import { Obj } from '@dxos/echo';
 import { type ThemedClassName } from '@dxos/react-ui';
 import {
   ChessModel,
@@ -24,7 +27,7 @@ import {
   useGameboardContext,
 } from '@dxos/react-ui-gameboard';
 import { useSoundEffect } from '@dxos/react-ui-sfx';
-import { mx } from '@dxos/react-ui-theme';
+import { mx } from '@dxos/ui-theme';
 
 import { type Chess } from '../types';
 
@@ -35,8 +38,11 @@ export interface ChessboardController {
 }
 
 export class ExtendedChessModel extends ChessModel {
-  constructor(readonly object: Chess.Game) {
-    super();
+  constructor(
+    registry: Registry.Registry,
+    readonly object: Chess.Game,
+  ) {
+    super(registry);
   }
 }
 
@@ -49,7 +55,8 @@ type RootProps = PropsWithChildren<{
 }>;
 
 const Root = forwardRef<ChessboardController, RootProps>(({ game, children }, forwardedRef) => {
-  const model = useMemo(() => new ExtendedChessModel(game), []);
+  const registry = useContext(RegistryContext);
+  const model = useMemo(() => new ExtendedChessModel(registry, game), [registry]);
   const click = useSoundEffect('Click');
 
   // Controller.
@@ -79,7 +86,9 @@ const Root = forwardRef<ChessboardController, RootProps>(({ game, children }, fo
       }
 
       void click.play();
-      game.pgn = model.pgn;
+      Obj.change(game, (g) => {
+        g.pgn = model.pgn;
+      });
       return true;
     },
     [model],
@@ -119,6 +128,7 @@ const Content = ({ classNames, children, role }: ContentProps) => {
 type BoardProps = NaturalChessboardProps;
 
 const Board = (props: BoardProps) => {
+  const registry = useContext(RegistryContext);
   const { model } = useGameboardContext<ChessModel>(Board.displayName);
 
   // Keyboard navigation.
@@ -132,6 +142,7 @@ const Board = (props: BoardProps) => {
     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);
@@ -140,18 +151,18 @@ const Board = (props: BoardProps) => {
           model.setMoveIndex(model.game.history().length);
           break;
         case 'ArrowLeft':
-          if (model.moveIndex.value > 0) {
-            model.setMoveIndex(model.moveIndex.value - 1);
+          if (moveIndex > 0) {
+            model.setMoveIndex(moveIndex - 1);
           }
           break;
         case 'ArrowRight':
-          if (model.moveIndex.value < model.game.history().length) {
-            model.setMoveIndex(model.moveIndex.value + 1);
+          if (moveIndex < model.game.history().length) {
+            model.setMoveIndex(moveIndex + 1);
           }
           break;
       }
     });
-  }, [model]);
+  }, [registry, model]);
 
   return <NaturalChessboard ref={ref} {...props} />;
 };

package/src/components/ChessboardArticle.tsx

@@ -4,17 +4,20 @@
 
 import React, { useCallback, useRef, useState } from 'react';
 
-import { IconButton, Toolbar, useTranslation } from '@dxos/react-ui';
+import { type SurfaceComponentProps } from '@dxos/app-framework/react';
+import { Toolbar, useTranslation } from '@dxos/react-ui';
 import { type Player } from '@dxos/react-ui-gameboard';
-import { StackItem } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
+import { Layout } from '@dxos/react-ui-mosaic';
+import { mx } from '@dxos/ui-theme';
 
 import { meta } from '../meta';
 import { type Chess } from '../types';
 
 import { Chessboard, type ChessboardController, type ChessboardInfoProps } from './Chessboard';
 
-export const ChessboardArticle = ({ game, role }: { game: Chess.Game; role?: string }) => {
+export type ChessboardArticleProps = SurfaceComponentProps<Chess.Game>;
+
+export const ChessboardArticle = ({ role, subject: game }: ChessboardArticleProps) => {
   const { t } = useTranslation(meta.id);
   const [orientation, setOrientation] = useState<Player>('white');
   const [open, setOpen] = useState(true);
@@ -26,22 +29,21 @@ export const ChessboardArticle = ({ game, role }: { game: Chess.Game; role?: str
   }, []);
 
   return (
-    <StackItem.Content toolbar classNames='@container bs-full is-full overflow-hidden'>
+    <Layout.Main toolbar classNames='@container'>
       <Chessboard.Root game={game} ref={controller}>
         <Toolbar.Root>
-          <IconButton
-            variant='ghost'
+          <Toolbar.IconButton
             icon='ph--info--regular'
             iconOnly
             label={t('toggle info button')}
-            size={6}
-            classNames={mx('invisible', !open && '@3xl:visible')}
+            disabled={open}
+            classNames={mx('invisible @3xl:visible')}
             onClick={() => setOpen((open) => !open)}
           />
         </Toolbar.Root>
         <div
           className={mx(
-            'grid _grid-rows-[1fr_4rem] bs-full is-full gap-2',
+            'grid bs-full is-full gap-2',
             open && '@3xl:grid-cols-[1fr_320px]',
             role === 'section' && 'aspect-square',
             role === 'section' && open && '@3xl:aspect-auto',
@@ -64,6 +66,6 @@ export const ChessboardArticle = ({ game, role }: { game: Chess.Game; role?: str
           )}
         </div>
       </Chessboard.Root>
-    </StackItem.Content>
+    </Layout.Main>
   );
 };

package/src/components/ChessboardContainer.tsx

@@ -4,31 +4,27 @@
 
 import React from 'react';
 
-import { getSpace } from '@dxos/react-client/echo';
+import { type SurfaceComponentProps } from '@dxos/app-framework/react';
+import { Obj } from '@dxos/echo';
 
 import { type Chess } from '../types';
 
 import { Chessboard } from './Chessboard';
 import { ChessboardArticle } from './ChessboardArticle';
 
-export type ChessboardContainerProps = {
-  game: Chess.Game;
-  role?: string;
-};
+export type ChessboardContainerProps = SurfaceComponentProps<Chess.Game>;
 
-export const ChessboardContainer = ({ game, role }: ChessboardContainerProps) => {
-  const space = getSpace(game);
-  if (!space) {
+export const ChessboardContainer = ({ role, subject: game }: ChessboardContainerProps) => {
+  const db = Obj.getDatabase(game);
+  if (!db) {
     return null;
   }
 
   switch (role) {
-    case 'card--popover':
-    case 'card--intrinsic':
-    case 'card--extrinsic': {
+    case 'card--content': {
       return (
         <Chessboard.Root game={game}>
-          <Chessboard.Content role={role}>
+          <Chessboard.Content>
             <Chessboard.Board />
           </Chessboard.Content>
         </Chessboard.Root>
@@ -36,7 +32,7 @@ export const ChessboardContainer = ({ game, role }: ChessboardContainerProps) =>
     }
 
     default: {
-      return <ChessboardArticle game={game} role={role} />;
+      return <ChessboardArticle role={role} subject={game} />;
     }
   }
 };

package/src/components/Info.tsx

@@ -2,13 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
+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 { type SpaceMember, getSpace, useMembers } from '@dxos/react-client/echo';
+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 { type Player, useGameboardContext } from '@dxos/react-ui-gameboard';
-import { mx } from '@dxos/react-ui-theme';
+import { mx } from '@dxos/ui-theme';
 
 import { meta } from '../meta';
 
@@ -25,7 +27,8 @@ export type InfoProps = ThemedClassName<
 export const Info = ({ classNames, orientation = 'white', onOrientationChange, onClose, ...props }: InfoProps) => {
   const { t } = useTranslation(meta.id);
   const { model } = useGameboardContext<ExtendedChessModel>(Info.displayName);
-  const members = useMembers(getSpace(model.object)?.key);
+  const db = Obj.getDatabase(model.object);
+  const members = useMembers(db?.spaceId);
 
   return (
     <div
@@ -97,14 +100,15 @@ type HistoryProps = ThemedClassName<{
 
 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')
+      ? t('game.checkmate label')
       : model.game.isStalemate()
-        ? t('game.stalemate')
-        : t('game.draw')
+        ? t('game.stalemate label')
+        : t('game.draw label')
     : model.game.isCheck()
-      ? t('game.check')
+      ? t('game.check label')
       : undefined;
 
   const history = model.game.history();
@@ -130,16 +134,16 @@ const History = ({ classNames, model, min, max, onSelect }: HistoryProps) => {
   }, [history.length]);
 
   useEffect(() => {
-    const div = scrollerRef.current?.querySelector(`[data-index="${model.moveIndex.value - 1}"]`);
+    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');
-  }, [model.moveIndex.value]);
+  }, [moveIndex]);
 
   return (
     <div
       ref={scrollerRef}
-      className={mx('overflow-y-scroll', classNames)}
+      className={mx('overflow-y-auto', classNames)}
       style={{
         minHeight: min === undefined ? 'auto' : `${min * 24}px`,
         maxHeight: max === undefined ? 'auto' : `${max * 24}px`,
@@ -151,7 +155,7 @@ const History = ({ classNames, model, min, max, onSelect }: HistoryProps) => {
           {a && (
             <div
               data-index={a.index}
-              className={mx('pis-2 cursor-pointer', a.index === model.moveIndex.value - 1 && 'bg-primary-500')}
+              className={mx('pis-2 cursor-pointer', a.index === moveIndex - 1 && 'bg-primary-500')}
               onClick={() => onSelect?.(a.index + 1)}
             >
               {a.move}
@@ -160,7 +164,7 @@ const History = ({ classNames, model, min, max, onSelect }: HistoryProps) => {
           {b && (
             <div
               data-index={b.index}
-              className={mx('pis-2 cursor-pointer', b.index === model.moveIndex.value - 1 && 'bg-primary-500')}
+              className={mx('pis-2 cursor-pointer', b.index === moveIndex - 1 && 'bg-primary-500')}
               onClick={() => onSelect?.(b.index + 1)}
             >
               {b.move}
@@ -186,7 +190,7 @@ 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] pis-1 pie-1 flex items-center overflow-hidden'>
+    <div className='grid grid-cols-[2rem_1fr_2rem] gap-2 bs-[--rail-size] pli-1 flex items-center overflow-hidden'>
       <div className='place-items-center'>
         <Icon
           icon={turn ? 'ph--circle--fill' : 'ph--circle--thin'}

package/src/index.ts

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

package/src/meta.ts

@@ -2,18 +2,18 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
-export const CHESS_PLUGIN = 'dxos.org/plugin/chess';
-
-export const meta: PluginMeta = {
-  id: CHESS_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/chess',
   name: 'Chess',
   description: trim`
-    Play chess with friends or practice with the AI.
+    Full-featured chess game supporting multiplayer matches with friends or practice sessions against AI opponents.
+    Track game history and analyze moves in real-time.
   `,
   icon: 'ph--shield-chevron--regular',
+  iconHue: 'amber',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-chess',
   screenshots: ['https://dxos.network/plugin-details-chess-dark.png'],
 };

package/src/translations.ts

@@ -18,18 +18,19 @@ export const translations = [
         'object name placeholder': 'New game',
         'rename object label': 'Rename game',
         'delete object label': 'Delete game',
-        'toggle info button': 'Toggle info',
-        'close info button': 'Close info',
-        'flip board button': 'Flip board',
-        'select player button': 'Select player',
+        'object deleted label': 'Game deleted',
       },
       [meta.id]: {
         'plugin name': 'Chess',
         'delete game label': 'Delete',
-        'game.checkmate': 'Checkmate',
-        'game.stalemate': 'Stalemate',
-        'game.draw': 'Draw',
-        'game.check': 'Check',
+        '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',
       },
     },
   },