@dxos/plugin-chess 0.7.5-main.499c70c → 0.7.5-main.5ae2ba8

package/dist/types/src/types/types.d.ts

@@ -1,23 +1,20 @@
-import type { IntentResolverProvides, MetadataRecordsProvides, SurfaceProvides, TranslationsProvides } from '@dxos/app-framework';
 import { S } from '@dxos/echo-schema';
-import { type SchemaProvides } from '@dxos/plugin-space';
-import { GameType } from './schema';
+import { ChessType } from './schema';
 export declare namespace ChessAction {
     const Create_base: S.TaggedClass<Create, "dxos.org/plugin/chess/action/create", {
         readonly _tag: S.tag<"dxos.org/plugin/chess/action/create">;
     } & {
         input: S.Struct<{
             name: S.optional<typeof S.String>;
+            fen: S.optional<typeof S.String>;
         }>;
         output: S.Struct<{
-            object: typeof GameType;
+            object: typeof ChessType;
         }>;
     }>;
     export class Create extends Create_base {
     }
     export {};
 }
-export type ChessProvides = {};
-export type ChessPluginProvides = SurfaceProvides & IntentResolverProvides & MetadataRecordsProvides & TranslationsProvides & SchemaProvides;
-export declare const isObject: (object: unknown) => object is GameType;
+export declare const isObject: (object: unknown) => object is typeof ChessType;
 //# sourceMappingURL=types.d.ts.map

package/dist/types/src/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,sBAAsB,EACtB,uBAAuB,EACvB,eAAe,EACf,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAEtC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,WAAW,CAAC;;;;;;;;;;;IAG3B,MAAM,OAAO,MAAO,SAAQ,WAO1B;KAAG;;CACN;AAED,MAAM,MAAM,aAAa,GAAG,EAAE,CAAC;AAE/B,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAC/C,sBAAsB,GACtB,uBAAuB,GACvB,oBAAoB,GACpB,cAAc,CAAC;AAEjB,eAAO,MAAM,QAAQ,WAAY,OAAO,KAAG,MAAM,IAAI,QAEpD,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAgB,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAGpD,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrC,yBAAiB,WAAW,CAAC;;;;;;;;;;;;IAG3B,MAAM,OAAO,MAAO,SAAQ,WAQ1B;KAAG;;CACN;AAED,eAAO,MAAM,QAAQ,WAAY,OAAO,KAAG,MAAM,IAAI,OAAO,SAE3D,CAAC"}

package/dist/types/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"version":"5.7.2"}
+{"version":"5.7.3"}

package/package.json

@@ -1,23 +1,19 @@
 {
   "name": "@dxos/plugin-chess",
-  "version": "0.7.5-main.499c70c",
+  "version": "0.7.5-main.5ae2ba8",
   "description": "Chess for new plugin",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": true,
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
     },
-    "./meta": {
-      "types": "./dist/types/src/meta.d.ts",
-      "browser": "./dist/lib/browser/meta.mjs",
-      "node": "./dist/lib/node-esm/meta.mjs"
-    },
     "./types": {
       "types": "./dist/types/src/types/index.d.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
@@ -27,9 +23,6 @@
   "types": "dist/types/src/index.d.ts",
   "typesVersions": {
     "*": {
-      "meta": [
-        "dist/types/src/meta.d.ts"
-      ],
       "types": [
         "dist/types/src/types/index.d.ts"
       ]
@@ -42,19 +35,22 @@
   "dependencies": {
     "@effect/schema": "^0.75.5",
     "@preact/signals-core": "^1.6.0",
-    "chess.js": "^1.0.0-beta.8",
-    "react-chessboard": "^4.7.1",
-    "react-resize-detector": "^11.0.1",
-    "@dxos/app-framework": "0.7.5-main.499c70c",
-    "@dxos/async": "0.7.5-main.499c70c",
-    "@dxos/display-name": "0.7.5-main.499c70c",
-    "@dxos/invariant": "0.7.5-main.499c70c",
-    "@dxos/echo-schema": "0.7.5-main.499c70c",
-    "@dxos/live-object": "0.7.5-main.499c70c",
-    "@dxos/plugin-client": "0.7.5-main.499c70c",
-    "@dxos/plugin-space": "0.7.5-main.499c70c",
-    "@dxos/plugin-graph": "0.7.5-main.499c70c",
-    "@dxos/react-client": "0.7.5-main.499c70c"
+    "chess.js": "^1.0.0",
+    "effect": "^3.12.3",
+    "@dxos/app-framework": "0.7.5-main.5ae2ba8",
+    "@dxos/assistant": "0.7.5-main.5ae2ba8",
+    "@dxos/artifact": "0.7.5-main.5ae2ba8",
+    "@dxos/async": "0.7.5-main.5ae2ba8",
+    "@dxos/display-name": "0.7.5-main.5ae2ba8",
+    "@dxos/echo-schema": "0.7.5-main.5ae2ba8",
+    "@dxos/live-object": "0.7.5-main.5ae2ba8",
+    "@dxos/invariant": "0.7.5-main.5ae2ba8",
+    "@dxos/plugin-client": "0.7.5-main.5ae2ba8",
+    "@dxos/plugin-graph": "0.7.5-main.5ae2ba8",
+    "@dxos/plugin-space": "0.7.5-main.5ae2ba8",
+    "@dxos/react-client": "0.7.5-main.5ae2ba8",
+    "@dxos/react-ui-gameboard": "0.7.5-main.5ae2ba8",
+    "@dxos/react-ui-stack": "0.7.5-main.5ae2ba8"
   },
   "devDependencies": {
     "@phosphor-icons/react": "^2.1.5",
@@ -63,16 +59,16 @@
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
     "vite": "5.4.7",
-    "@dxos/react-ui": "0.7.5-main.499c70c",
-    "@dxos/react-ui-theme": "0.7.5-main.499c70c",
-    "@dxos/storybook-utils": "0.7.5-main.499c70c"
+    "@dxos/react-ui": "0.7.5-main.5ae2ba8",
+    "@dxos/react-ui-theme": "0.7.5-main.5ae2ba8",
+    "@dxos/storybook-utils": "0.7.5-main.5ae2ba8"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.1.5",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.7.5-main.499c70c",
-    "@dxos/react-ui-theme": "0.7.5-main.499c70c"
+    "@dxos/react-ui-theme": "0.7.5-main.5ae2ba8",
+    "@dxos/react-ui": "0.7.5-main.5ae2ba8"
   },
   "publishConfig": {
     "access": "public"

package/src/ChessPlugin.tsx

@@ -2,50 +2,60 @@
 // Copyright 2023 DXOS.org
 //
 
-import React from 'react';
+import { Capabilities, contributes, createIntent, defineModule, definePlugin, Events } from '@dxos/app-framework';
+import { ClientEvents } from '@dxos/plugin-client';
+import { SpaceCapabilities } from '@dxos/plugin-space';
+import { defineObjectForm } from '@dxos/plugin-space/types';
 
-import { createIntent, createResolver, createSurface, type PluginDefinition } from '@dxos/app-framework';
-import { create } from '@dxos/live-object';
-
-import ChessContainer from './components/ChessContainer';
-import meta, { CHESS_PLUGIN } from './meta';
+import { ArtifactDefinition, IntentResolver, ReactSurface } from './capabilities';
+import { CHESS_PLUGIN, meta } from './meta';
 import translations from './translations';
-import { ChessAction, type ChessPluginProvides, GameType, isObject } from './types';
+import { ChessAction, ChessType } from './types';
 
-export const ChessPlugin = (): PluginDefinition<ChessPluginProvides> => {
-  return {
-    meta,
-    provides: {
-      metadata: {
-        records: {
-          [GameType.typename]: {
-            createObject: (props: { name?: string }) => createIntent(ChessAction.Create, props),
+export const ChessPlugin = () =>
+  definePlugin(meta, [
+    defineModule({
+      id: `${meta.id}/module/translations`,
+      activatesOn: Events.SetupTranslations,
+      activate: () => contributes(Capabilities.Translations, translations),
+    }),
+    defineModule({
+      id: `${meta.id}/module/metadata`,
+      activatesOn: Events.SetupMetadata,
+      activate: () =>
+        contributes(Capabilities.Metadata, {
+          id: ChessType.typename,
+          metadata: {
             placeholder: ['game title placeholder', { ns: CHESS_PLUGIN }],
             icon: 'ph--shield-chevron--regular',
           },
-        },
-      },
-      echo: {
-        schema: [GameType],
-      },
-      translations,
-      surface: {
-        definitions: () =>
-          createSurface({
-            id: CHESS_PLUGIN,
-            role: ['article', 'section'],
-            filter: (data): data is { subject: GameType } => isObject(data.subject),
-            component: ({ data, role }) => <ChessContainer game={data.subject} role={role} />,
+        }),
+    }),
+    defineModule({
+      id: `${meta.id}/module/object-form`,
+      activatesOn: ClientEvents.SetupSchema,
+      activate: () =>
+        contributes(
+          SpaceCapabilities.ObjectForm,
+          defineObjectForm({
+            objectSchema: ChessType,
+            getIntent: () => createIntent(ChessAction.Create),
           }),
-      },
-      intent: {
-        resolvers: () =>
-          createResolver(ChessAction.Create, ({ name }) => ({
-            data: {
-              object: create(GameType, { name }),
-            },
-          })),
-      },
-    },
-  };
-};
+        ),
+    }),
+    defineModule({
+      id: `${meta.id}/module/react-surface`,
+      activatesOn: Events.SetupReactSurface,
+      activate: ReactSurface,
+    }),
+    defineModule({
+      id: `${meta.id}/module/intent-resolver`,
+      activatesOn: Events.SetupIntentResolver,
+      activate: IntentResolver,
+    }),
+    defineModule({
+      id: `${meta.id}/module/artifact-definition`,
+      activatesOn: Events.SetupArtifactDefinition,
+      activate: ArtifactDefinition,
+    }),
+  ]);

package/src/capabilities/artifact-definition.ts

@@ -0,0 +1,115 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Chess } from 'chess.js';
+import { pipe } from 'effect';
+
+import { Capabilities, chain, contributes, createIntent, type PromiseIntentDispatcher } from '@dxos/app-framework';
+import { defineArtifact, defineTool, ToolResult } from '@dxos/artifact';
+import { createArtifactElement } from '@dxos/assistant';
+import { isInstanceOf, ObjectId, S } from '@dxos/echo-schema';
+import { invariant } from '@dxos/invariant';
+import { SpaceAction } from '@dxos/plugin-space/types';
+import { Filter, type Space } from '@dxos/react-client/echo';
+
+import { meta } from '../meta';
+import { ChessAction, ChessType } from '../types';
+
+// TODO(burdon): Factor out.
+declare global {
+  interface ToolContextExtensions {
+    space?: Space;
+    dispatch?: PromiseIntentDispatcher;
+  }
+}
+
+export default () => {
+  const definition = defineArtifact({
+    id: meta.id,
+    name: meta.name,
+    description: 'Provides a simple chess engine.',
+    instructions: `
+      - 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.
+    `,
+    schema: ChessType,
+    tools: [
+      defineTool(meta.id, {
+        name: 'create',
+        description: 'Create a new chess game. Returns the artifact definition for the game.',
+        caption: 'Creating chess game...',
+        schema: S.Struct({
+          fen: S.String.annotations({ description: 'The state of the chess game in the FEN format.' }),
+        }),
+        execute: async ({ fen }, { extensions }) => {
+          invariant(extensions?.space, 'No space');
+          invariant(extensions?.dispatch, 'No intent dispatcher');
+          const intent = pipe(
+            createIntent(ChessAction.Create, { fen }),
+            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));
+        },
+      }),
+      defineTool(meta.id, {
+        name: 'list',
+        description: 'Query all active chess games.',
+        caption: 'Getting games...',
+        schema: S.Struct({}),
+        execute: async (_, { extensions }) => {
+          invariant(extensions?.space, 'No space');
+          const { objects: games } = await extensions.space.db.query(Filter.schema(ChessType)).run();
+          invariant(games.length > 0, 'No chess games found');
+          return ToolResult.Success(games);
+        },
+      }),
+      defineTool(meta.id, {
+        name: 'inspect',
+        description: 'Get the current state of the chess game.',
+        caption: 'Inspecting game...',
+        schema: S.Struct({ id: ObjectId }),
+        execute: async ({ id }, { extensions }) => {
+          invariant(extensions?.space, 'No space');
+          const { objects: games } = await extensions.space.db.query(Filter.schema(ChessType)).run();
+          const game = games.find((game) => game.id === id);
+          invariant(isInstanceOf(ChessType, game));
+          return ToolResult.Success(game.fen);
+        },
+      }),
+      defineTool(meta.id, {
+        name: 'move',
+        description: 'Make a move in the chess game.',
+        caption: 'Making chess move...',
+        schema: S.Struct({
+          id: ObjectId,
+          move: S.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 { objects: games } = await extensions.space.db.query(Filter.schema(ChessType)).run();
+          const game = games.find((game) => game.id === id);
+          invariant(isInstanceOf(ChessType, game));
+          const board = new Chess(game.fen);
+          try {
+            board.move(move);
+          } catch (error: any) {
+            return ToolResult.Error(error.message);
+          }
+          game.pgn = board.pgn();
+          game.fen = board.fen();
+          return ToolResult.Success(game.fen);
+        },
+      }),
+    ],
+  });
+
+  return contributes(Capabilities.ArtifactDefinition, definition);
+};

package/src/capabilities/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { lazy } from '@dxos/app-framework';
+
+export const ArtifactDefinition = lazy(() => import('./artifact-definition'));
+export const IntentResolver = lazy(() => import('./intent-resolver'));
+export const ReactSurface = lazy(() => import('./react-surface'));

package/src/capabilities/intent-resolver.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Chess } from 'chess.js';
+
+import { Capabilities, contributes, createResolver } from '@dxos/app-framework';
+import { create } from '@dxos/live-object';
+
+import { ChessAction, ChessType } from '../types';
+
+export default () =>
+  contributes(
+    Capabilities.IntentResolver,
+    createResolver({
+      intent: ChessAction.Create,
+      resolve: ({ name, fen }) => {
+        const pgn = fen ? new Chess(fen).pgn() : undefined;
+        return {
+          data: {
+            object: create(ChessType, { name, fen, pgn }),
+          },
+        };
+      },
+    }),
+  );

package/src/capabilities/react-surface.tsx

@@ -0,0 +1,29 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
+import { isInstanceOf } from '@dxos/echo-schema';
+
+import { ChessContainer } from '../components';
+import { ChessComponent } from '../components/ChessComponent';
+import { CHESS_PLUGIN } from '../meta';
+import { ChessType, isObject } from '../types';
+
+export default () =>
+  contributes(Capabilities.ReactSurface, [
+    createSurface({
+      id: CHESS_PLUGIN,
+      role: ['article', 'section'],
+      filter: (data): data is { subject: ChessType } => isObject(data.subject),
+      component: ({ data, role }) => <ChessContainer game={data.subject} role={role} />,
+    }),
+    createSurface({
+      id: 'plugin-chess',
+      role: 'canvas-node',
+      filter: (data): data is any => isInstanceOf(ChessType, data),
+      component: ({ data }) => <ChessComponent game={data} />,
+    }),
+  ]);

package/src/components/ChessComponent.tsx

@@ -0,0 +1,49 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Chess } from 'chess.js';
+import React, { useCallback, useEffect, useMemo } from 'react';
+
+import { getSpace } from '@dxos/react-client/echo';
+import { ChessModel, Board, Chessboard, type BoardRootProps } from '@dxos/react-ui-gameboard';
+
+import { type ChessType } from '../types';
+
+export const ChessComponent = ({ game }: { game: ChessType }) => {
+  const model = useMemo(() => new ChessModel(), []);
+  useEffect(() => {
+    if (!model || game.pgn !== model?.game.pgn()) {
+      const chess = new Chess();
+      if (game.pgn) {
+        chess.loadPgn(game.pgn);
+      }
+
+      model.initialize(chess.fen());
+    }
+  }, [game.pgn]);
+
+  const space = getSpace(game);
+  if (!space) {
+    return null;
+  }
+
+  const handleDrop = useCallback<NonNullable<BoardRootProps['onDrop']>>(
+    (move) => {
+      if (model.makeMove(move)) {
+        game.pgn = model.game.pgn();
+        game.fen = model.game.fen();
+        return true;
+      }
+
+      return false;
+    },
+    [model],
+  );
+
+  return (
+    <Board.Root model={model} onDrop={handleDrop}>
+      <Chessboard />
+    </Board.Root>
+  );
+};

package/src/components/ChessContainer.tsx

@@ -2,22 +2,33 @@
 // Copyright 2024 DXOS.org
 //
 
-import React, { type ComponentProps } from 'react';
+import React from 'react';
 
 import { getSpace } from '@dxos/react-client/echo';
+import { StackItem } from '@dxos/react-ui-stack';
 
-import { Chess } from './Chess';
+import { ChessComponent } from './ChessComponent';
+import { PlayerSelector } from './PlayerSelector';
+import { type ChessType } from '../types';
 
-const ChessContainer = ({ game, role }: Pick<ComponentProps<typeof Chess>, 'game'> & { role?: string }) => {
+const ChessContainer = ({ game }: { game: ChessType; role?: string }) => {
   const space = getSpace(game);
   if (!space) {
     return null;
   }
 
   return (
-    <div role='none' className='flex flex-col row-span-2 is-full overflow-hidden'>
-      <Chess game={game} space={space} playerSelector={role === 'article'} />
-    </div>
+    <StackItem.Content toolbar={false}>
+      <div role='none' className='grid grid-rows-[60px_1fr_60px] grow overflow-hidden'>
+        <div />
+
+        <div className='flex m-4 overflow-hidden'>
+          <ChessComponent game={game} />
+        </div>
+
+        <PlayerSelector space={space} game={game} />
+      </div>
+    </StackItem.Content>
   );
 };
 

package/src/components/ChessPanel.tsx

@@ -0,0 +1,67 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { ArrowURightDown, Circle } from '@phosphor-icons/react';
+import { type Color } from 'chess.js';
+import React, { type FC } from 'react';
+
+import { type ThemedClassName } from '@dxos/react-ui';
+import { type ChessModel } from '@dxos/react-ui-gameboard';
+import { getSize, mx } from '@dxos/react-ui-theme';
+
+export type ChessPanelProps = ThemedClassName<{
+  model: ChessModel;
+  orientation?: Color;
+  onFlip?: () => void;
+}>;
+
+export const ChessPanel: FC<ChessPanelProps> = ({ classNames, model, orientation = 'w', onFlip }) => {
+  const game = model.game;
+  const history = game.history();
+  const label = game.isGameOver()
+    ? game.isCheckmate()
+      ? 'CHECKMATE'
+      : game.isStalemate()
+        ? 'STALEMATE'
+        : 'DRAW'
+    : game.isCheck()
+      ? 'CHECK'
+      : history.length
+        ? `Move ${history.length}`
+        : '';
+
+  const Player = ({ color }: { color: Color }) => {
+    const turn = color === game.turn();
+
+    return (
+      <div className='flex items-center'>
+        <Circle
+          className={mx(getSize(4), turn && (game.isCheckmate() ? 'text-red-500' : 'text-green-500'))}
+          weight={turn ? 'fill' : 'thin'}
+        />
+      </div>
+    );
+  };
+
+  return (
+    <div className={mx('flex flex-col', classNames)}>
+      <div className='flex items-center justify-between pl-2 pr-2 border-b' style={{ height: 32 }}>
+        <Player color={orientation === 'w' ? 'b' : 'w'} />
+        {onFlip && (
+          <button onClick={onFlip}>
+            <ArrowURightDown weight='thin' className={getSize(6)} />
+          </button>
+        )}
+      </div>
+
+      <div className='flex flex-col justify-center pl-2 font-thin' style={{ height: 40 }}>
+        {label}
+      </div>
+
+      <div className='flex items-center justify-between pl-2 pr-2 border-t' style={{ height: 32 }}>
+        <Player color={orientation} />
+      </div>
+    </div>
+  );
+};

package/src/components/Chessboard.stories.tsx

@@ -0,0 +1,39 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import '@dxos-theme';
+
+import { type Meta, type StoryObj } from '@storybook/react';
+import React, { useMemo } from 'react';
+
+import { Board, Chessboard, ChessModel } from '@dxos/react-ui-gameboard';
+import { withLayout, withTheme } from '@dxos/storybook-utils';
+
+import { ChessPanel } from './ChessPanel';
+
+const Render = () => {
+  const model = useMemo(() => new ChessModel(), []);
+
+  return (
+    <div className='flex grow mx-8 gap-8 items-center overflow-hidden'>
+      <Board.Root model={model} onDrop={(move) => model.makeMove(move)}>
+        <Chessboard />
+      </Board.Root>
+      <ChessPanel model={model} classNames='w-[200px]' />
+    </div>
+  );
+};
+
+const meta: Meta<typeof Chessboard> = {
+  title: 'plugins/plugin-chess/Chessboard',
+  component: Chessboard,
+  render: Render,
+  decorators: [withTheme, withLayout({ fullscreen: true })],
+};
+
+type Story = StoryObj<typeof Chessboard>;
+
+export default meta;
+
+export const Default: Story = {};