@dxos/plugin-chess 0.8.4-main.937b3ca → 0.8.4-main.9be5663bfe

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

@@ -12,9 +12,11 @@ import { Icon, IconButton, Select, type ThemedClassName, useTranslation } from '
 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';
 
 export type InfoProps = ThemedClassName<
   {
@@ -26,14 +28,14 @@ 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 { 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,
       )}
     >
@@ -42,14 +44,23 @@ 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) => {
-            model.object.players![orientation === 'white' ? 'black' : 'white'] = value;
+            Obj.change(model.object, (obj) => {
+              obj.players![orientation === 'white' ? 'black' : 'white'] = value;
+            });
           }}
           members={members}
         />
@@ -66,7 +77,7 @@ 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')}
             />
@@ -76,7 +87,9 @@ export const Info = ({ classNames, orientation = 'white', onOrientationChange, o
         <PlayerSelector
           value={model.object.players?.[orientation]}
           onValueChange={(value) => {
-            model.object.players![orientation] = value;
+            Obj.change(model.object, (obj) => {
+              obj.players![orientation] = value;
+            });
           }}
           members={members}
         />
@@ -85,7 +98,7 @@ export const Info = ({ classNames, orientation = 'white', onOrientationChange, o
   );
 };
 
-Info.displayName = 'Chessboard.Info';
+Info.displayName = INFO_NAME;
 
 //
 // History
@@ -103,12 +116,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();
@@ -150,12 +163,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}
@@ -164,7 +177,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}
@@ -190,12 +203,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>
@@ -218,7 +231,7 @@ 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.TriggerButton placeholder={t('select-player.button')} />
       <Select.Portal>
         <Select.Content>
           <Select.Viewport>

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.Game,
+  ) {
+    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}

@@ -6,26 +6,26 @@ import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo } from 'react';
 
 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 { Chess } from '#types';
 
-import { ChessboardArticle } from './ChessboardArticle';
+import { translations } from '../../translations';
+import { ChessArticle } from './ChessArticle';
 
-type StoryProps = {
+type DefaultStoryProps = {
   pgn?: string;
 };
 
-const DefaultStory = ({ pgn }: StoryProps) => {
+const DefaultStory = ({ pgn }: DefaultStoryProps) => {
   const game = useMemo(() => Chess.make(pgn ? { pgn } : undefined), [pgn]);
-  return <ChessboardArticle subject={game} />;
+  return <ChessArticle role='article' subject={game} attendableId='story' />;
 };
 
 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,73 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useCallback, useRef, useState } from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+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';
+
+export type ChessArticleProps = AppSurface.ObjectArticleProps<Chess.Game>;
+
+export const ChessArticle = ({ role, attendableId: _attendableId, subject: game }: 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);
+  }, []);
+
+  return (
+    <Chessboard.Root game={game} ref={controller}>
+      <Panel.Root role={role} classNames='@container'>
+        <Panel.Toolbar asChild>
+          <Toolbar.Root>
+            <Toolbar.IconButton
+              icon='ph--info--regular'
+              iconOnly
+              label={t('toggle-info.button')}
+              disabled={showInfo}
+              classNames={mx('invisible @3xl:visible')}
+              onClick={() => setShowInfo((open) => !open)}
+            />
+          </Toolbar.Root>
+        </Panel.Toolbar>
+        <Panel.Content>
+          <div
+            className={mx(
+              'grid h-full w-full',
+              showInfo && '@3xl:grid-cols-[1fr_320px] gap-8',
+              role === 'article' && 'p-4',
+              role === 'section' && 'aspect-square',
+              role === 'section' && showInfo && '@3xl:aspect-auto',
+            )}
+          >
+            <Chessboard.Content>
+              <Chessboard.Board classNames='border rounded-xs' orientation={orientation} />
+            </Chessboard.Content>
+            {showInfo && (
+              <div className='hidden @3xl: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/{components/Card.stories.tsx → containers/ChessCard/ChessCard.stories.tsx}

@@ -5,37 +5,32 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo } from 'react';
 
-import { withTheme } from '@dxos/react-ui/testing';
 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 { Chessboard } from './Chessboard';
+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 *';
 
-// 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>
-          <Chessboard.Board />
-        </Chessboard.Content>
-      </Chessboard.Root>
+    <CardContainer role='popover' icon={pluginMeta.icon}>
+      <ChessCard subject={game} role='card--content' />
     </CardContainer>
   );
 };
 
 const meta = {
-  title: 'plugins/plugin-chess/Card',
+  title: 'plugins/plugin-chess/containers/ChessCard',
   render: () => <CardStory />,
-  decorators: [withTheme],
+  decorators: [withTheme(), withLayout({ layout: 'column' })],
   parameters: {
-    layout: 'centered',
+    layout: 'fullscreen',
   },
   tags: ['cards'],
 } satisfies Meta;

package/src/containers/ChessCard/ChessCard.tsx

@@ -0,0 +1,22 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+
+import { Chessboard } from '#components';
+import { type Chess } from '#types';
+
+export type ChessCardProps = AppSurface.ObjectCardProps<Chess.Game>;
+
+export const ChessCard = ({ subject: game }: ChessCardProps) => {
+  return (
+    <Chessboard.Root game={game}>
+      <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

@@ -3,8 +3,7 @@
 //
 
 export * from './blueprints';
-export * from './capabilities';
-export * from './components';
+export * from './components/Chessboard';
 export * from './meta';
 export * from './types';
 

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.

package/src/operations/create.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Database } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+
+import { Chess } from '../types';
+import { Create } from './definitions';
+
+const handler: Operation.WithHandler<typeof Create> = Create.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ name, pgn, fen }) {
+      return yield* Database.add(Chess.make({ name, pgn, fen }));
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/definitions.ts

@@ -0,0 +1,109 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Database, Ref } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+
+import { Chess } from '../types';
+
+export const Create = Operation.make({
+  meta: {
+    key: 'org.dxos.function.chess.create',
+    name: 'Create Chess',
+    description: 'Creates a new chess game.',
+  },
+  input: Schema.Struct({
+    name: Schema.optional(
+      Schema.String.annotations({
+        description: 'Name of the game.',
+      }),
+    ),
+    pgn: Schema.optional(
+      Schema.String.annotations({
+        description: 'Portable Game Notation.',
+      }),
+    ),
+    fen: Schema.optional(
+      Schema.String.annotations({
+        description: 'Forsyth-Edwards Notation.',
+      }),
+    ),
+  }),
+  output: Chess.Game,
+  services: [Database.Service],
+});
+
+export const Move = Operation.make({
+  meta: {
+    key: 'org.dxos.function.chess.move',
+    name: 'Move',
+    description: 'Makes a move in the given chess game.',
+  },
+  input: Schema.Struct({
+    game: Ref.Ref(Chess.Game).annotations({
+      description: 'The ID of the chess object.',
+    }),
+    move: Schema.String.annotations({
+      description: 'The move to make in the chess game.',
+      examples: ['e4', 'Bf3'],
+    }),
+  }),
+  output: Schema.Struct({
+    pgn: Schema.String.annotations({
+      description: 'The PGN of the game after the move was played.',
+    }),
+  }),
+  services: [Database.Service],
+});
+
+export const Play = Operation.make({
+  meta: {
+    key: 'org.dxos.function.chess.play',
+    name: 'Play',
+    description: 'Uses the chess engine to play the next move.',
+  },
+  input: Schema.Struct({
+    game: Ref.Ref(Chess.Game).annotations({
+      description: 'The ID of the chess object.',
+    }),
+    side: Schema.optional(Schema.Literal('white', 'black', 'any')).annotations({
+      description: 'The side to play.',
+      defaultValue: 'any',
+    }),
+  }),
+  output: Schema.Struct({
+    pgn: Schema.String.annotations({
+      description: 'The PGN of the game after the move was played.',
+    }),
+    move: Schema.optional(Schema.String).annotations({
+      description: 'The move that was played.',
+    }),
+  }),
+  services: [Database.Service],
+});
+
+export const Print = Operation.make({
+  meta: {
+    key: 'org.dxos.function.chess.print',
+    name: 'Print game',
+    description: 'Prints the chess game to ASCII.',
+  },
+  input: Schema.Struct({
+    pgn: Schema.optional(
+      Schema.String.annotations({
+        description: 'Portable Game Notation.',
+      }),
+    ),
+    fen: Schema.optional(
+      Schema.String.annotations({
+        description: 'Forsyth-Edwards Notation.',
+      }),
+    ),
+  }),
+  output: Schema.Struct({
+    ascii: Schema.String,
+  }),
+});

package/src/operations/index.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/operation';
+
+const Handlers = OperationHandlerSet.lazy(
+  () => import('./create'),
+  () => import('./move'),
+  () => import('./play'),
+  () => import('./print'),
+);
+
+export { Create, Move, Play, Print } from './definitions';
+
+export const ChessHandlers = Handlers;

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 { Database, Obj } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+
+import { type Chess } from '../types';
+import { Move } from './definitions';
+
+const handler: Operation.WithHandler<typeof Move> = Move.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ game, move }) {
+      const obj = (yield* Database.load(game)) as Chess.Game;
+      const chess = new ChessJS();
+      if (obj.pgn) {
+        chess.loadPgn(obj.pgn);
+      } else if (obj.fen) {
+        chess.load(obj.fen);
+      }
+
+      chess.move(move, { strict: false });
+      const pgn = chess.pgn();
+      Obj.change(obj, (obj) => {
+        const mutableGame = obj as Obj.Mutable<typeof obj>;
+        mutableGame.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 { Database, Obj } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+
+import { type Chess } from '../types';
+import { Play } from './definitions';
+
+const handler: Operation.WithHandler<typeof Play> = Play.pipe(
+  Operation.withHandler(
+    Effect.fn(function* ({ game, side = 'any' }) {
+      const object = (yield* Database.load(game)) as Chess.Game;
+      const chess = new ChessJS();
+      if (object.pgn) {
+        chess.loadPgn(object.pgn);
+      } else if (object.fen) {
+        chess.load(object.fen);
+      }
+
+      if (
+        !(side === 'any' || (chess.turn() === 'w' && side === 'white') || (chess.turn() === 'b' && side === 'black'))
+      ) {
+        return { move: undefined, pgn: object.pgn! };
+      }
+
+      const moves = chess.moves();
+      const move = moves[Math.floor(Math.random() * moves.length)];
+
+      chess.move(move, { strict: false });
+      const pgn = chess.pgn();
+      Obj.change(object, (object) => {
+        const mutableGame = object as Obj.Mutable<typeof object>;
+        mutableGame.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/operation';
+
+import { Print } from './definitions';
+
+const handler: Operation.WithHandler<typeof Print> = 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;