@dxos/plugin-chess 0.8.4-main.67995b8 → 0.8.4-main.a4bbb77

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/plugin-chess",
-  "version": "0.8.4-main.67995b8",
+  "version": "0.8.4-main.a4bbb77",
   "description": "Chess for new plugin",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -10,16 +10,22 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
-      "node": "./dist/lib/node-esm/index.mjs",
-      "source": "./src/index.ts"
+      "node": "./dist/lib/node-esm/index.mjs"
     },
     "./types": {
+      "source": "./src/types/index.ts",
       "types": "./dist/types/src/types/index.d.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
-      "node": "./dist/lib/node-esm/types/index.mjs",
-      "source": "./src/types/index.ts"
+      "node": "./dist/lib/node-esm/types/index.mjs"
+    },
+    "./functions": {
+      "source": "./src/functions/index.ts",
+      "types": "./dist/types/src/functions/index.d.ts",
+      "browser": "./dist/lib/browser/functions/index.mjs",
+      "node": "./dist/lib/node-esm/functions/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -36,43 +42,47 @@
   ],
   "dependencies": {
     "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
+    "@preact/signals-core": "^1.12.1",
     "chess.js": "^1.0.0",
-    "effect": "3.17.0",
-    "@dxos/ai": "0.8.4-main.67995b8",
-    "@dxos/app-framework": "0.8.4-main.67995b8",
-    "@dxos/async": "0.8.4-main.67995b8",
-    "@dxos/assistant": "0.8.4-main.67995b8",
-    "@dxos/display-name": "0.8.4-main.67995b8",
-    "@dxos/blueprints": "0.8.4-main.67995b8",
-    "@dxos/echo": "0.8.4-main.67995b8",
-    "@dxos/invariant": "0.8.4-main.67995b8",
-    "@dxos/echo-schema": "0.8.4-main.67995b8",
-    "@dxos/live-object": "0.8.4-main.67995b8",
-    "@dxos/log": "0.8.4-main.67995b8",
-    "@dxos/plugin-client": "0.8.4-main.67995b8",
-    "@dxos/plugin-graph": "0.8.4-main.67995b8",
-    "@dxos/plugin-space": "0.8.4-main.67995b8",
-    "@dxos/react-client": "0.8.4-main.67995b8",
-    "@dxos/react-ui-gameboard": "0.8.4-main.67995b8",
-    "@dxos/react-ui-stack": "0.8.4-main.67995b8"
+    "effect": "3.18.3",
+    "@dxos/ai": "0.8.4-main.a4bbb77",
+    "@dxos/app-framework": "0.8.4-main.a4bbb77",
+    "@dxos/assistant": "0.8.4-main.a4bbb77",
+    "@dxos/echo": "0.8.4-main.a4bbb77",
+    "@dxos/blueprints": "0.8.4-main.a4bbb77",
+    "@dxos/display-name": "0.8.4-main.a4bbb77",
+    "@dxos/echo-schema": "0.8.4-main.a4bbb77",
+    "@dxos/async": "0.8.4-main.a4bbb77",
+    "@dxos/functions": "0.8.4-main.a4bbb77",
+    "@dxos/log": "0.8.4-main.a4bbb77",
+    "@dxos/plugin-client": "0.8.4-main.a4bbb77",
+    "@dxos/live-object": "0.8.4-main.a4bbb77",
+    "@dxos/invariant": "0.8.4-main.a4bbb77",
+    "@dxos/plugin-graph": "0.8.4-main.a4bbb77",
+    "@dxos/plugin-space": "0.8.4-main.a4bbb77",
+    "@dxos/react-ui-gameboard": "0.8.4-main.a4bbb77",
+    "@dxos/react-client": "0.8.4-main.a4bbb77",
+    "@dxos/react-ui-sfx": "0.8.4-main.a4bbb77",
+    "@dxos/react-ui-stack": "0.8.4-main.a4bbb77",
+    "@dxos/schema": "0.8.4-main.a4bbb77",
+    "@dxos/util": "0.8.4-main.a4bbb77"
   },
   "devDependencies": {
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/plugin-theme": "0.8.4-main.67995b8",
-    "@dxos/react-ui": "0.8.4-main.67995b8",
-    "@dxos/react-ui-theme": "0.8.4-main.67995b8",
-    "@dxos/storybook-utils": "0.8.4-main.67995b8"
+    "@types/react": "~19.2.0",
+    "@types/react-dom": "~19.2.0",
+    "react": "~19.2.0",
+    "react-dom": "~19.2.0",
+    "vite": "7.1.9",
+    "@dxos/plugin-theme": "0.8.4-main.a4bbb77",
+    "@dxos/react-ui": "0.8.4-main.a4bbb77",
+    "@dxos/react-ui-theme": "0.8.4-main.a4bbb77",
+    "@dxos/storybook-utils": "0.8.4-main.a4bbb77"
   },
   "peerDependencies": {
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.67995b8",
-    "@dxos/react-ui-theme": "0.8.4-main.67995b8"
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "@dxos/react-ui": "0.8.4-main.a4bbb77",
+    "@dxos/react-ui-theme": "0.8.4-main.a4bbb77"
   },
   "publishConfig": {
     "access": "public"

package/src/ChessPlugin.tsx

@@ -2,59 +2,59 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Capabilities, contributes, createIntent, defineModule, definePlugin, Events } from '@dxos/app-framework';
+import { Capabilities, Events, contributes, createIntent, defineModule, definePlugin } from '@dxos/app-framework';
 import { ClientEvents } from '@dxos/plugin-client';
 import { SpaceCapabilities } from '@dxos/plugin-space';
 import { defineObjectForm } from '@dxos/plugin-space/types';
 
-import { ArtifactDefinition, IntentResolver, ReactSurface } from './capabilities';
+import { BLUEPRINT_KEY, BlueprintDefinition, IntentResolver, ReactSurface } from './capabilities';
 import { meta } from './meta';
 import { translations } from './translations';
-import { ChessAction, ChessType } from './types';
+import { Chess, ChessAction } from './types';
 
-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: {
-            icon: 'ph--shield-chevron--regular',
-          },
+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: Chess.Game.typename,
+        metadata: {
+          icon: 'ph--shield-chevron--regular',
+          blueprints: [BLUEPRINT_KEY],
+        },
+      }),
+  }),
+  defineModule({
+    id: `${meta.id}/module/object-form`,
+    activatesOn: ClientEvents.SetupSchema,
+    activate: () =>
+      contributes(
+        SpaceCapabilities.ObjectForm,
+        defineObjectForm({
+          objectSchema: Chess.Game,
+          getIntent: () => createIntent(ChessAction.Create),
         }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/object-form`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () =>
-        contributes(
-          SpaceCapabilities.ObjectForm,
-          defineObjectForm({
-            objectSchema: ChessType,
-            getIntent: () => createIntent(ChessAction.Create),
-          }),
-        ),
-    }),
-    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,
-    }),
-  ]);
+      ),
+  }),
+  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/blueprint`,
+    activatesOn: Events.SetupArtifactDefinition,
+    activate: BlueprintDefinition,
+  }),
+]);

package/src/capabilities/artifact-definition.ts

@@ -2,20 +2,24 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Chess } from 'chess.js';
-import { pipe, Schema } from 'effect';
+// ISSUE(burdon): defineArtifact
+// @ts-nocheck
 
-import { createTool, ToolResult } from '@dxos/ai';
-import { Capabilities, chain, contributes, createIntent, type PromiseIntentDispatcher } from '@dxos/app-framework';
-import { createArtifactElement, VersionPin, ArtifactId } from '@dxos/assistant';
+import { Chess as ChessJS } from 'chess.js';
+import { Schema, pipe } from 'effect';
+
+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 { ChessAction, ChessType } from '../types';
+import { Chess, ChessAction } from '../types';
 
 // TODO(burdon): Factor out.
 declare global {
@@ -30,24 +34,24 @@ export default () => {
     id: `artifact:${meta.id}`,
     name: meta.name,
     description: 'Provides a simple chess engine.',
-    instructions: `
+    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: ChessType,
+    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({
-          fen: Schema.String.annotations({ description: 'The state of the chess game in the FEN format.' }),
+          pgn: Schema.String.annotations({ description: 'The state of the chess game in the PGN format.' }),
         }),
-        execute: async ({ fen }, { extensions }) => {
+        execute: async ({ pgn }, { extensions }) => {
           invariant(extensions?.space, 'No space');
           invariant(extensions?.dispatch, 'No intent dispatcher');
           const intent = pipe(
-            createIntent(ChessAction.Create, { fen }),
+            createIntent(ChessAction.Create, { pgn }),
             chain(SpaceAction.AddObject, { target: extensions.space }),
           );
           const { data, error } = await extensions.dispatch(intent);
@@ -67,7 +71,7 @@ export default () => {
         schema: Schema.Struct({}),
         execute: async (_, { extensions }) => {
           invariant(extensions?.space, 'No space');
-          const { objects: games } = await extensions.space.db.query(Filter.type(ChessType)).run();
+          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);
@@ -83,9 +87,9 @@ export default () => {
           const game = await extensions.space.db
             .query(Filter.ids(ArtifactId.toDXN(id, extensions.space.id).toString()))
             .first();
-          invariant(Obj.instanceOf(ChessType, game));
+          invariant(Obj.instanceOf(Chess.Game, game));
 
-          return ToolResult.Success(game.fen);
+          return ToolResult.Success(game.pgn);
         },
       }),
       createTool(meta.id, {
@@ -104,17 +108,17 @@ export default () => {
           const game = await extensions.space.db
             .query(Filter.ids(ArtifactId.toDXN(id, extensions.space.id).toString()))
             .first();
-          invariant(Obj.instanceOf(ChessType, game));
+          invariant(Obj.instanceOf(Chess.Game, game));
 
-          const board = new Chess(game.fen);
+          const chess = new ChessJS(game.pgn);
           try {
-            board.move(move);
+            chess.move(move);
           } catch (error: any) {
             return ToolResult.Error(error.message);
           }
-          game.pgn = board.pgn();
-          game.fen = board.fen();
-          return ToolResult.Success(game.fen);
+
+          game.pgn = chess.pgn();
+          return ToolResult.Success(game.pgn);
         },
       }),
     ],

package/src/capabilities/blueprint-definition.ts

@@ -0,0 +1,36 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capabilities, contributes } from '@dxos/app-framework';
+import { Blueprint, Template } from '@dxos/blueprints';
+import { type FunctionDefinition } from '@dxos/functions';
+import { trim } from '@dxos/util';
+
+import { create, move, play } from '../functions';
+
+export const BLUEPRINT_KEY = 'dxos.org/blueprint/chess';
+
+const functions: FunctionDefinition[] = [create, move, play];
+
+export default () => {
+  return [
+    contributes(Capabilities.Functions, functions),
+    contributes(
+      Capabilities.BlueprintDefinition,
+      Blueprint.make({
+        key: BLUEPRINT_KEY,
+        name: 'Chess',
+        tools: Blueprint.toolDefinitions({ functions }),
+        instructions: Template.make({
+          source: trim`
+            You are an expert chess player.
+            To analyze a game you can access the "pgn" property by loading the context object that represents the current game.
+            You could suggest a good next move or offer to play a move.
+            Don't actually make a move unless you are asked to.
+          `,
+        }),
+      }),
+    ),
+  ];
+};

package/src/capabilities/index.ts

@@ -4,6 +4,8 @@
 
 import { lazy } from '@dxos/app-framework';
 
-export const ArtifactDefinition = lazy(() => import('./artifact-definition'));
+export const BlueprintDefinition = lazy(() => import('./blueprint-definition'));
 export const IntentResolver = lazy(() => import('./intent-resolver'));
 export const ReactSurface = lazy(() => import('./react-surface'));
+
+export * from './blueprint-definition';

package/src/capabilities/intent-resolver.ts

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

package/src/capabilities/react-surface.tsx

@@ -7,17 +7,17 @@ import React from 'react';
 import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
 import { Obj } from '@dxos/echo';
 
-import { ChessContainer } from '../components';
+import { ChessboardContainer } from '../components';
 import { meta } from '../meta';
-import { ChessType } from '../types';
+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 (like below)?
-      filter: (data): data is { subject: ChessType } => Obj.instanceOf(ChessType, data.subject),
-      component: ({ data, role }) => <ChessContainer game={data.subject} role={role} />,
+      // 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

@@ -0,0 +1,66 @@
+//
+// 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: Meta<DefaultStoryProps> = {
+  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'],
+};
+
+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

@@ -2,40 +2,48 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useMemo } from 'react';
-
-import { Gameboard, Chessboard, ChessModel } from '@dxos/react-ui-gameboard';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
-
-import { ChessPanel } from './ChessPanel';
-
-const DefaultStory = () => {
-  const model = useMemo(() => new ChessModel(), []);
-
-  return (
-    <div className='flex grow mx-8 gap-8 items-center overflow-hidden'>
-      <Gameboard.Root model={model} onDrop={(move) => model.makeMove(move)}>
-        <Gameboard.Content>
-          <Chessboard />
-        </Gameboard.Content>
-      </Gameboard.Root>
-      <ChessPanel model={model} classNames='w-[200px]' />
-    </div>
-  );
-};
 
-const meta: Meta<typeof Chessboard> = {
-  title: 'plugins/plugin-chess/Chessboard',
-  component: Chessboard,
-  render: DefaultStory,
-  decorators: [withTheme, withLayout({ fullscreen: true })],
-};
+import { withClientProvider } from '@dxos/react-client/testing';
+import { withTheme } from '@dxos/react-ui/testing';
 
-type Story = StoryObj<typeof Chessboard>;
+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;
 
-export const Default: Story = {};
+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 *',
+    }),
+  },
+};