@dxos/plugin-chess 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

package/src/containers/ChessArticle/ChessArticle.tsx

@@ -0,0 +1,73 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useCallback, useRef, useState } from 'react';
+
+import { type ObjectSurfaceProps } 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 = ObjectSurfaceProps<Chess.Game>;
+
+export const ChessArticle = ({ role, 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,7 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { ChessArticle } from './ChessArticle';
+
+export default ChessArticle;

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

@@ -0,0 +1,42 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo } from 'react';
+
+import { withLayout, 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 { 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 = useMemo(() => Chess.make({ pgn: SAMPLE_PGN }), []);
+  return (
+    <CardContainer role='popover' icon={pluginMeta.icon}>
+      <ChessCard subject={game} />
+    </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,22 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { type ObjectSurfaceProps } from '@dxos/app-toolkit/ui';
+
+import { Chessboard } from '#components';
+import { type Chess } from '#types';
+
+export type ChessCardProps = ObjectSurfaceProps<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,7 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { ChessCard } from './ChessCard';
+
+export default 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,8 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-export * from './capabilities';
-export * from './components';
+export * from './blueprints';
+export * from './components/Chessboard';
 export * from './meta';
+export * from './types';
 
 export * from './ChessPlugin';

package/src/meta.ts

@@ -2,16 +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: 'org.dxos.plugin.chess',
   name: 'Chess',
-  description:
-    'Chess is a simple plugin which allows you to render an interactive chessboard inside of a plank. This chessboard can be used for collaborative chess games, or for practice experiments with the LLM. ',
+  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.
+  `,
   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/operations/create.ts

@@ -0,0 +1,22 @@
+//
+// 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 { Operation } from '@dxos/operation';
+import * as Schema from 'effect/Schema';
+
+import { Database, Ref } from '@dxos/echo';
+
+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,37 @@
+//
+// 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, (game) => {
+        const mutableGame = game as Obj.Mutable<typeof game>;
+        mutableGame.pgn = pgn;
+      });
+      return { pgn };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/play.ts

@@ -0,0 +1,46 @@
+//
+// 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, (game) => {
+        const mutableGame = game as Obj.Mutable<typeof game>;
+        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;

package/src/translations.ts

@@ -4,24 +4,34 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
-import { ChessType } from './types';
+import { meta } from '#meta';
+import { Chess } from '#types';
 
 export const translations = [
   {
     'en-US': {
-      [ChessType.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',
+      [Chess.Game.typename]: {
+        'typename.label': 'Game',
+        'typename.label_zero': 'Games',
+        'typename.label_one': 'Game',
+        'typename.label_other': 'Games',
+        'object-name.placeholder': 'New game',
+        'add-object.label': 'Add game',
+        'rename-object.label': 'Rename game',
+        'delete-object.label': 'Delete game',
+        'object-deleted.label': 'Game deleted',
       },
       [meta.id]: {
-        'plugin name': 'Chess',
-        'delete game label': 'Delete',
+        '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',
       },
     },
   },

package/src/types/Chess.ts

@@ -0,0 +1,62 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Chess as ChessJS } from 'chess.js';
+import * as Schema from 'effect/Schema';
+
+import { Annotation, Obj, Type } from '@dxos/echo';
+import { FormInputAnnotation, LabelAnnotation } from '@dxos/echo/internal';
+import { log } from '@dxos/log';
+
+export const Game = Schema.Struct({
+  name: Schema.optional(Schema.String),
+  players: Schema.Struct({
+    white: Schema.optional(
+      Schema.String.annotations({
+        description: 'DID of white player',
+      }),
+    ),
+    black: Schema.optional(
+      Schema.String.annotations({
+        description: 'DID of black player',
+      }),
+    ),
+  }).pipe(FormInputAnnotation.set(false), Schema.optional),
+  pgn: Schema.String.annotations({
+    description: 'Portable Game Notation.',
+  }).pipe(FormInputAnnotation.set(false), Schema.optional),
+  fen: Schema.String.annotations({
+    description: 'Forsyth-Edwards Notation.',
+  }).pipe(FormInputAnnotation.set(false), Schema.optional),
+}).pipe(
+  Type.object({
+    typename: 'org.dxos.type.chess',
+    version: '0.1.0',
+  }),
+  LabelAnnotation.set(['name']),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--shield-chevron--regular',
+    hue: 'amber',
+  }),
+);
+
+export interface Game extends Schema.Schema.Type<typeof Game> {}
+
+export const make = ({ name, pgn, fen }: { name?: string; pgn?: string; fen?: string } = {}) => {
+  const chess = new ChessJS();
+  if (pgn) {
+    try {
+      chess.loadPgn(pgn);
+    } catch {
+      log.warn(pgn);
+    }
+  }
+
+  return Obj.make(Game, {
+    name,
+    pgn,
+    fen,
+    players: {},
+  });
+};

package/src/types/index.ts

@@ -2,5 +2,4 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './schema';
-export * from './types';
+export * as Chess from './Chess';