@dxos/plugin-chess 0.8.4-main.e8ec1fe → 0.8.4-main.effb148878

package/src/capabilities/artifact-definition.ts

@@ -1,129 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// ISSUE(burdon): defineArtifact
-// @ts-nocheck
-
-import { Chess as ChessJS } from 'chess.js';
-import * as Function from 'effect/Function';
-import * as Schema from 'effect/Schema';
-
-import { ToolResult, createTool } from '@dxos/ai';
-import { Capabilities, type PromiseIntentDispatcher, chain, contributes, createIntent } from '@dxos/app-framework';
-import { ArtifactId, VersionPin, createArtifactElement } from '@dxos/assistant';
-import { defineArtifact } from '@dxos/blueprints';
-import { Obj } from '@dxos/echo';
-import { invariant } from '@dxos/invariant';
-import { SpaceAction } from '@dxos/plugin-space/types';
-import { Filter, type Space } from '@dxos/react-client/echo';
-import { trim } from '@dxos/util';
-
-import { meta } from '../meta';
-import { Chess, ChessAction } from '../types';
-
-// TODO(burdon): Factor out.
-declare global {
-  interface ToolContextExtensions {
-    space?: Space;
-    dispatch?: PromiseIntentDispatcher;
-  }
-}
-
-export default () => {
-  const definition = defineArtifact({
-    id: `artifact:${meta.id}`,
-    name: meta.name,
-    description: 'Provides a simple chess engine.',
-    instructions: trim`
-      - If the user's message relates to a chess game, you must return the chess game inside the artifact tag as a valid FEN string with no additional text.
-      - Always inspect the chess game at the start of every prompt realting to a chess game, as it might have changed since the interaction.
-   `,
-    schema: Chess.Game,
-    tools: [
-      createTool(meta.id, {
-        name: 'create',
-        description: 'Create a new chess game. Returns the artifact definition for the game.',
-        caption: 'Creating chess game...',
-        schema: Schema.Struct({
-          pgn: Schema.String.annotations({ description: 'The state of the chess game in the PGN format.' }),
-        }),
-        execute: async ({ pgn }, { extensions }) => {
-          invariant(extensions?.space, 'No space');
-          invariant(extensions?.dispatch, 'No intent dispatcher');
-          const intent = Function.pipe(
-            createIntent(ChessAction.Create, { pgn }),
-            chain(SpaceAction.AddObject, { target: extensions.space }),
-          );
-          const { data, error } = await extensions.dispatch(intent);
-          if (!data || error) {
-            return ToolResult.Error(error?.message ?? 'Failed to create chess game');
-          }
-
-          return ToolResult.Success(createArtifactElement(data.id), [
-            VersionPin.createBlock(VersionPin.fromObject(data.object)),
-          ]);
-        },
-      }),
-      createTool(meta.id, {
-        name: 'list',
-        description: 'Query all active chess games.',
-        caption: 'Getting games...',
-        schema: Schema.Struct({}),
-        execute: async (_, { extensions }) => {
-          invariant(extensions?.space, 'No space');
-          const { objects: games } = await extensions.space.db.query(Filter.type(Chess.Game)).run();
-          invariant(games.length > 0, 'No chess games found');
-
-          return ToolResult.Success(games);
-        },
-      }),
-      createTool(meta.id, {
-        name: 'inspect',
-        description: 'Get the current state of the chess game.',
-        caption: 'Inspecting game...',
-        schema: Schema.Struct({ id: ArtifactId }),
-        execute: async ({ id }, { extensions }) => {
-          invariant(extensions?.space, 'No space');
-          const game = await extensions.space.db
-            .query(Filter.ids(ArtifactId.toDXN(id, extensions.space.id).toString()))
-            .first();
-          invariant(Obj.instanceOf(Chess.Game, game));
-
-          return ToolResult.Success(game.pgn);
-        },
-      }),
-      createTool(meta.id, {
-        name: 'move',
-        description: 'Make a move in the chess game.',
-        caption: 'Making chess move...',
-        schema: Schema.Struct({
-          id: ArtifactId,
-          move: Schema.String.annotations({
-            description: 'The move to make in the chess game.',
-            examples: ['e4', 'Bf3'],
-          }),
-        }),
-        execute: async ({ id, move }, { extensions }) => {
-          invariant(extensions?.space, 'No space');
-          const game = await extensions.space.db
-            .query(Filter.ids(ArtifactId.toDXN(id, extensions.space.id).toString()))
-            .first();
-          invariant(Obj.instanceOf(Chess.Game, game));
-
-          const chess = new ChessJS(game.pgn);
-          try {
-            chess.move(move);
-          } catch (error: any) {
-            return ToolResult.Error(error.message);
-          }
-
-          game.pgn = chess.pgn();
-          return ToolResult.Success(game.pgn);
-        },
-      }),
-    ],
-  });
-
-  return contributes(Capabilities.ArtifactDefinition, definition);
-};

package/src/capabilities/intent-resolver.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes, createResolver } from '@dxos/app-framework';
-
-import { Chess, ChessAction } from '../types';
-
-export default () =>
-  contributes(
-    Capabilities.IntentResolver,
-    createResolver({
-      intent: ChessAction.Create,
-      resolve: ({ name, pgn }) => {
-        return {
-          data: {
-            object: Chess.makeGame({ name, pgn }),
-          },
-        };
-      },
-    }),
-  );

package/src/capabilities/react-surface.tsx

@@ -1,23 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-import { Obj } from '@dxos/echo';
-
-import { ChessboardContainer } from '../components';
-import { meta } from '../meta';
-import { Chess } from '../types';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: meta.id,
-      role: ['article', 'section', 'card--intrinsic', 'card--extrinsic', 'card--popover', 'card--transclusion'],
-      // 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 game={data.subject} role={role} />,
-    }),
-  ]);

package/src/components/Card.stories.tsx

@@ -1,66 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { withTheme } from '@dxos/react-ui/testing';
-import { CardContainer } from '@dxos/react-ui-stack/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 meta = {
-  title: 'plugins/plugin-chess/Card',
-  render: ({ role, game }) => (
-    <CardContainer icon={pluginMeta.icon} role={role}>
-      <Chessboard.Root game={game}>
-        <Chessboard.Content role={role}>
-          <Chessboard.Board />
-        </Chessboard.Content>
-      </Chessboard.Root>
-    </CardContainer>
-  ),
-  decorators: [withTheme],
-  parameters: {
-    layout: 'centered',
-  },
-  tags: ['cards'],
-} satisfies Meta<DefaultStoryProps>;
-
-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,
-  },
-};

package/src/components/Chessboard.stories.tsx

@@ -1,49 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-
-import { withClientProvider } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/react-ui/testing';
-
-import { translations } from '../translations';
-import { Chess } from '../types';
-
-import { ChessboardArticle } from './ChessboardArticle';
-
-const meta = {
-  title: 'plugins/plugin-chess/Chessboard',
-  component: ChessboardArticle,
-  decorators: [withTheme, withClientProvider({ createIdentity: true })],
-  parameters: {
-    layout: 'fullscreen',
-    translations,
-  },
-} satisfies Meta<typeof ChessboardArticle>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {
-    game: Chess.makeGame(),
-  },
-};
-
-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 *',
-    }),
-  },
-};
-
-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 *',
-    }),
-  },
-};

package/src/components/ChessboardArticle.tsx

@@ -1,68 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useRef, useState } from '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 { 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 }) => {
-  const { t } = useTranslation(meta.id);
-  const [orientation, setOrientation] = useState<Player>('white');
-  const [open, setOpen] = useState(true);
-  const controller = useRef<ChessboardController>(null);
-
-  // TODO(burdon): Keyboard handler.
-  const handleSelect = useCallback<NonNullable<ChessboardInfoProps['onSelect']>>((index) => {
-    controller.current?.setMoveNumber(index);
-  }, []);
-
-  return (
-    <StackItem.Content toolbar classNames='@container'>
-      <Chessboard.Root game={game} ref={controller}>
-        <Toolbar.Root>
-          <Toolbar.IconButton
-            icon='ph--info--regular'
-            iconOnly
-            label={t('toggle info button')}
-            disabled={open}
-            classNames={mx('invisible @3xl:visible')}
-            onClick={() => setOpen((open) => !open)}
-          />
-        </Toolbar.Root>
-        <div
-          className={mx(
-            'grid bs-full is-full gap-2',
-            open && '@3xl:grid-cols-[1fr_320px]',
-            role === 'section' && 'aspect-square',
-            role === 'section' && open && '@3xl:aspect-auto',
-          )}
-        >
-          <Chessboard.Content>
-            <Chessboard.Board classNames='m-4 rounded-sm overflow-hidden' orientation={orientation} />
-          </Chessboard.Content>
-          {open && (
-            <div className='hidden @3xl:flex flex-col p-8 justify-center items-center overflow-hidden'>
-              <Chessboard.Info
-                orientation={orientation}
-                min={8}
-                max={8}
-                onOrientationChange={setOrientation}
-                onClose={() => setOpen(false)}
-                onSelect={handleSelect}
-              />
-            </div>
-          )}
-        </div>
-      </Chessboard.Root>
-    </StackItem.Content>
-  );
-};

package/src/components/ChessboardContainer.tsx

@@ -1,44 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React from 'react';
-
-import { getSpace } from '@dxos/react-client/echo';
-
-import { type Chess } from '../types';
-
-import { Chessboard } from './Chessboard';
-import { ChessboardArticle } from './ChessboardArticle';
-
-export type ChessboardContainerProps = {
-  game: Chess.Game;
-  role?: string;
-};
-
-export const ChessboardContainer = ({ game, role }: ChessboardContainerProps) => {
-  const space = getSpace(game);
-  if (!space) {
-    return null;
-  }
-
-  switch (role) {
-    case 'card--popover':
-    case 'card--intrinsic':
-    case 'card--extrinsic': {
-      return (
-        <Chessboard.Root game={game}>
-          <Chessboard.Content role={role}>
-            <Chessboard.Board />
-          </Chessboard.Content>
-        </Chessboard.Root>
-      );
-    }
-
-    default: {
-      return <ChessboardArticle game={game} role={role} />;
-    }
-  }
-};
-
-export default ChessboardContainer;

package/src/functions/create.ts

@@ -1,32 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { DatabaseService, defineFunction } from '@dxos/functions';
-
-import { Chess } from '../types';
-
-export default defineFunction({
-  key: 'dxos.org/function/chess/create',
-  name: 'Create Chess',
-  description: 'Creates a new chess game.',
-  inputSchema: Schema.Struct({
-    pgn: Schema.optional(
-      Schema.String.annotations({
-        description: 'Portable Game Notation.',
-      }),
-    ),
-    fen: Schema.optional(
-      Schema.String.annotations({
-        description: 'Forsyth-Edwards Notation.',
-      }),
-    ),
-  }),
-  outputSchema: Chess.Game,
-  handler: Effect.fn(function* ({ data: { pgn, fen } }) {
-    return yield* DatabaseService.add(Chess.makeGame({ pgn, fen }));
-  }),
-});

package/src/functions/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export { default as create } from './create';
-export { default as move } from './move';
-export { default as play } from './play';

package/src/functions/move.ts

@@ -1,45 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Chess as ChessJS } from 'chess.js';
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId } from '@dxos/assistant';
-import { DatabaseService, defineFunction } from '@dxos/functions';
-
-import { Chess } from '../types';
-
-export default defineFunction({
-  key: 'dxos.org/function/chess/move',
-  name: 'Move',
-  description: 'Makes a move in the given chess game.',
-  inputSchema: Schema.Struct({
-    id: ArtifactId.annotations({
-      description: 'The ID of the chess object.',
-    }),
-    move: Schema.String.annotations({
-      description: 'The move to make in the chess game.',
-      examples: ['e4', 'Bf3'],
-    }),
-  }),
-  outputSchema: Schema.Struct({
-    pgn: Schema.String.annotations({
-      description: 'The PGN of the game after the move was played.',
-    }),
-  }),
-  handler: Effect.fn(function* ({ data: { id, move } }) {
-    const object = yield* DatabaseService.resolve(ArtifactId.toDXN(id), Chess.Game);
-    const chess = new ChessJS();
-    if (object.pgn) {
-      chess.loadPgn(object.pgn);
-    } else if (object.fen) {
-      chess.load(object.fen);
-    }
-
-    chess.move(move, { strict: false });
-    object.pgn = chess.pgn();
-    return { pgn: object.pgn };
-  }),
-});

package/src/functions/play.ts

@@ -1,55 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Chess as ChessJS } from 'chess.js';
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId } from '@dxos/assistant';
-import { DatabaseService, defineFunction } from '@dxos/functions';
-
-import { Chess } from '../types';
-
-export default defineFunction({
-  key: 'dxos.org/function/chess/play',
-  name: 'Play',
-  description: 'Uses the chess engine to play the next move.',
-  inputSchema: Schema.Struct({
-    id: ArtifactId.annotations({
-      description: 'The ID of the chess object.',
-    }),
-    side: Schema.optional(Schema.Literal('white', 'black', 'any')).annotations({
-      description: 'The side to play.',
-      defaultValue: 'any',
-    }),
-  }),
-  outputSchema: 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.',
-    }),
-  }),
-  handler: Effect.fn(function* ({ data: { id, side = 'any' } }) {
-    const object = yield* DatabaseService.resolve(ArtifactId.toDXN(id), 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 });
-    object.pgn = chess.pgn();
-    return { move, pgn: object.pgn };
-  }),
-});

package/src/types/ChessAction.ts

@@ -1,19 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { meta } from '../meta';
-
-import { Game } from './Chess';
-
-export class Create extends Schema.TaggedClass<Create>()(`${meta.id}/action/create`, {
-  input: Schema.Struct({
-    name: Schema.optional(Schema.String),
-    pgn: Schema.optional(Schema.String),
-  }),
-  output: Schema.Struct({
-    object: Game,
-  }),
-}) {}