@dxos/plugin-chess 0.8.4-main.422d1c7879 → 0.8.4-main.43cb759274

package/src/components/Chessboard/types.ts

@@ -11,7 +11,7 @@ import { type Chess } from '#types';
 export class ExtendedChessModel extends ChessModel {
   constructor(
     registry: Registry.Registry,
-    readonly object: Chess.Game,
+    readonly object: Chess.State,
   ) {
     super(registry);
   }

package/src/containers/ChessArticle/ChessArticle.stories.tsx

@@ -5,12 +5,14 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo } from 'react';
 
+import { type Obj } from '@dxos/echo';
+import { make as makeGame } from '@dxos/plugin-game';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
+import { translations } from '#translations';
 import { Chess } from '#types';
 
-import { translations } from '../../translations';
 import { ChessArticle } from './ChessArticle';
 
 type DefaultStoryProps = {
@@ -18,8 +20,12 @@ type DefaultStoryProps = {
 };
 
 const DefaultStory = ({ pgn }: DefaultStoryProps) => {
-  const game = useMemo(() => Chess.make(pgn ? { pgn } : undefined), [pgn]);
-  return <ChessArticle role='article' subject={game} attendableId='story' />;
+  const { game, state } = useMemo(() => {
+    const state = Chess.make(pgn ? { pgn } : undefined);
+    const game = makeGame({ name: 'Story game', variant: state as Obj.Unknown });
+    return { game, state };
+  }, [pgn]);
+  return <ChessArticle role='article' attendableId='story' game={game} variant={state} />;
 };
 
 const meta = {

package/src/containers/ChessArticle/ChessArticle.tsx

@@ -2,20 +2,22 @@
 // Copyright 2024 DXOS.org
 //
 
+import { Chess as ChessJS } from 'chess.js';
 import React, { useCallback, useRef, useState } from 'react';
 
-import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { type GameVariantSurfaceProps } from '@dxos/plugin-game';
 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';
+import { Chess } from '#types';
 
-export type ChessArticleProps = AppSurface.ObjectArticleProps<Chess.Game>;
+export type ChessArticleProps = GameVariantSurfaceProps;
 
-export const ChessArticle = ({ role, attendableId: _attendableId, subject: game }: ChessArticleProps) => {
+export const ChessArticle = ({ role, variant }: ChessArticleProps) => {
   const { t } = useTranslation(meta.id);
   const [orientation, setOrientation] = useState<Player>('white');
   const [showInfo, setShowInfo] = useState(true);
@@ -25,17 +27,50 @@ export const ChessArticle = ({ role, attendableId: _attendableId, subject: game
     controller.current?.setMoveNumber(index);
   }, []);
 
+  const isGameOver = (() => {
+    if (!Obj.instanceOf(Chess.State, variant) || (!variant.pgn && !variant.fen)) {
+      return false;
+    }
+    try {
+      const chess = new ChessJS();
+      if (variant.pgn) {
+        chess.loadPgn(variant.pgn);
+      } else if (variant.fen) {
+        chess.load(variant.fen);
+      }
+      return chess.isGameOver();
+    } catch {
+      return false;
+    }
+  })();
+
+  const handleNewGame = useCallback(() => {
+    if (!Obj.instanceOf(Chess.State, variant)) {
+      return;
+    }
+    Obj.update(variant, (variant) => {
+      const mutable = variant as Obj.Mutable<typeof variant>;
+      mutable.pgn = undefined;
+      mutable.fen = undefined;
+    });
+  }, [variant]);
+
+  if (!Obj.instanceOf(Chess.State, variant)) {
+    return null;
+  }
+
   return (
-    <Chessboard.Root game={game} ref={controller}>
+    <Chessboard.Root state={variant} ref={controller}>
       <Panel.Root role={role} classNames='@container'>
         <Panel.Toolbar asChild>
           <Toolbar.Root>
+            {isGameOver && <Toolbar.Button onClick={handleNewGame}>{t('new-game.button')}</Toolbar.Button>}
+            <div className='grow' />
             <Toolbar.IconButton
               icon='ph--info--regular'
               iconOnly
               label={t('toggle-info.button')}
-              disabled={showInfo}
-              classNames={mx('invisible @3xl:visible')}
+              classNames={mx('invisible @4xl:visible')}
               onClick={() => setShowInfo((open) => !open)}
             />
           </Toolbar.Root>
@@ -44,17 +79,17 @@ export const ChessArticle = ({ role, attendableId: _attendableId, subject: game
           <div
             className={mx(
               'grid h-full w-full',
-              showInfo && '@3xl:grid-cols-[1fr_320px] gap-8',
+              showInfo && '@4xl:grid-cols-[1fr_320px] gap-8',
               role === 'article' && 'p-4',
               role === 'section' && 'aspect-square',
-              role === 'section' && showInfo && '@3xl:aspect-auto',
+              role === 'section' && showInfo && '@4xl: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'>
+              <div className='hidden @4xl:flex flex-col justify-center items-center overflow-hidden'>
                 <Chessboard.Info
                   orientation={orientation}
                   min={8}

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

@@ -5,6 +5,7 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo } from 'react';
 
+import { make as makeGame } from '@dxos/plugin-game';
 import { CardContainer } from '@dxos/react-ui-mosaic/testing';
 import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
@@ -17,10 +18,14 @@ 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 }), []);
+  const { game, state } = useMemo(() => {
+    const state = Chess.make({ pgn: SAMPLE_PGN });
+    const game = makeGame({ name: 'Story game', variant: state });
+    return { game, state };
+  }, []);
   return (
     <CardContainer role='popover' icon={pluginMeta.icon}>
-      <ChessCard subject={game} role='card--content' />
+      <ChessCard role='card--content' game={game} variant={state} />
     </CardContainer>
   );
 };

package/src/containers/ChessCard/ChessCard.tsx

@@ -4,16 +4,21 @@
 
 import React from 'react';
 
-import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { type GameVariantSurfaceProps } from '@dxos/plugin-game';
 
 import { Chessboard } from '#components';
-import { type Chess } from '#types';
+import { Chess } from '#types';
 
-export type ChessCardProps = AppSurface.ObjectCardProps<Chess.Game>;
+export type ChessCardProps = GameVariantSurfaceProps;
+
+export const ChessCard = ({ variant }: ChessCardProps) => {
+  if (!Obj.instanceOf(Chess.State, variant)) {
+    return null;
+  }
 
-export const ChessCard = ({ subject: game }: ChessCardProps) => {
   return (
-    <Chessboard.Root game={game}>
+    <Chessboard.Root state={variant}>
       <Chessboard.Content>
         <Chessboard.Board />
       </Chessboard.Content>

package/src/index.ts

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

package/src/meta.ts

@@ -2,12 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Plugin } from '@dxos/app-framework';
+import { Plugin } from '@dxos/app-framework';
+import { DXN } from '@dxos/keys';
+import { meta as gameMeta } from '@dxos/plugin-game';
 import { trim } from '@dxos/util';
 
-export const meta: Plugin.Meta = {
-  id: 'org.dxos.plugin.chess',
+export const meta = Plugin.makeMeta({
+  key: DXN.make('org.dxos.plugin.chess'),
   name: 'Chess',
+  author: 'DXOS',
   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.
@@ -15,5 +18,8 @@ export const meta: Plugin.Meta = {
   icon: 'ph--shield-chevron--regular',
   iconHue: 'amber',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-chess',
+  spec: 'PLUGIN.mdl',
   screenshots: ['https://dxos.network/plugin-details-chess-dark.png'],
-};
+  dependsOn: [gameMeta.id],
+  tags: ['game'],
+});

package/src/operations/index.ts

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

package/src/operations/move.ts

@@ -5,28 +5,28 @@
 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 { Operation } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { loadGame } from '@dxos/plugin-game';
 
-import { type Chess } from '../types';
-import { Move } from './definitions';
+import { Chess, ChessOperation } from '../types';
 
-const handler: Operation.WithHandler<typeof Move> = Move.pipe(
+const handler: Operation.WithHandler<typeof ChessOperation.Move> = ChessOperation.Move.pipe(
   Operation.withHandler(
     Effect.fn(function* ({ game, move }) {
-      const obj = (yield* Database.load(game)) as Chess.Game;
+      const { variant } = yield* loadGame(game, Chess.State);
       const chess = new ChessJS();
-      if (obj.pgn) {
-        chess.loadPgn(obj.pgn);
-      } else if (obj.fen) {
-        chess.load(obj.fen);
+      if (variant.pgn) {
+        chess.loadPgn(variant.pgn);
+      } else if (variant.fen) {
+        chess.load(variant.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;
+      Obj.update(variant, (variant) => {
+        const mutable = variant as Obj.Mutable<typeof variant>;
+        mutable.pgn = pgn;
       });
       return { pgn };
     }),

package/src/operations/play.ts

@@ -5,27 +5,27 @@
 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 { Operation } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { loadGame } from '@dxos/plugin-game';
 
-import { type Chess } from '../types';
-import { Play } from './definitions';
+import { Chess, ChessOperation } from '../types';
 
-const handler: Operation.WithHandler<typeof Play> = Play.pipe(
+const handler: Operation.WithHandler<typeof ChessOperation.Play> = ChessOperation.Play.pipe(
   Operation.withHandler(
     Effect.fn(function* ({ game, side = 'any' }) {
-      const object = (yield* Database.load(game)) as Chess.Game;
+      const { variant } = yield* loadGame(game, Chess.State);
       const chess = new ChessJS();
-      if (object.pgn) {
-        chess.loadPgn(object.pgn);
-      } else if (object.fen) {
-        chess.load(object.fen);
+      if (variant.pgn) {
+        chess.loadPgn(variant.pgn);
+      } else if (variant.fen) {
+        chess.load(variant.fen);
       }
 
       if (
         !(side === 'any' || (chess.turn() === 'w' && side === 'white') || (chess.turn() === 'b' && side === 'black'))
       ) {
-        return { move: undefined, pgn: object.pgn! };
+        return { move: undefined, pgn: variant.pgn ?? '' };
       }
 
       const moves = chess.moves();
@@ -33,9 +33,9 @@ const handler: Operation.WithHandler<typeof Play> = Play.pipe(
 
       chess.move(move, { strict: false });
       const pgn = chess.pgn();
-      Obj.change(object, (object) => {
-        const mutableGame = object as Obj.Mutable<typeof object>;
-        mutableGame.pgn = pgn;
+      Obj.update(variant, (variant) => {
+        const mutable = variant as Obj.Mutable<typeof variant>;
+        mutable.pgn = pgn;
       });
       return { move, pgn };
     }),

package/src/operations/print.ts

@@ -5,11 +5,11 @@
 import { Chess as ChessJS } from 'chess.js';
 import * as Effect from 'effect/Effect';
 
-import { Operation } from '@dxos/operation';
+import { Operation } from '@dxos/compute';
 
-import { Print } from './definitions';
+import { ChessOperation } from '../types';
 
-const handler: Operation.WithHandler<typeof Print> = Print.pipe(
+const handler: Operation.WithHandler<typeof ChessOperation.Print> = ChessOperation.Print.pipe(
   Operation.withHandler(
     Effect.fn(function* ({ pgn, fen }) {
       try {

package/src/plugin.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const ChessPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
+export { ChessOperationHandlerSet } from './operations';

package/src/testing.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// Eager re-export of `ChessPlugin`. See `@dxos/plugin-testing/src/core.ts`
+// for the rationale.
+export * from './ChessPlugin';

package/src/translations.ts

@@ -2,6 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+import { Type } from '@dxos/echo';
 import { type Resource } from '@dxos/react-ui';
 
 import { meta } from '#meta';
@@ -10,19 +11,15 @@ import { Chess } from '#types';
 export const translations = [
   {
     'en-US': {
-      [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',
+      [Type.getTypename(Chess.State)]: {
+        'typename.label': 'Chess',
+        'typename.label_zero': 'Chess games',
+        'typename.label_one': 'Chess game',
+        'typename.label_other': 'Chess games',
       },
       [meta.id]: {
         'plugin.name': 'Chess',
+        'new-game.button': 'New game',
         'delete-game.label': 'Delete',
         'game.checkmate.label': 'Checkmate',
         'game.stalemate.label': 'Stalemate',

package/src/types/Chess.ts

@@ -5,24 +5,18 @@
 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 { BlueprintsAnnotation } from '@dxos/app-toolkit';
+import { DXN, Annotation, Obj, Type } from '@dxos/echo';
+import { FormInputAnnotation, HiddenAnnotation } 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),
+export const BLUEPRINT_KEY = 'org.dxos.blueprint.chess';
+
+/**
+ * Chess variant state. Referenced by the base `Game` object via `Game.variant`.
+ * Players, name, and other game-shared fields live on the base `Game`.
+ */
+export const State = Schema.Struct({
   pgn: Schema.String.annotations({
     description: 'Portable Game Notation.',
   }).pipe(FormInputAnnotation.set(false), Schema.optional),
@@ -30,20 +24,19 @@ export const Game = Schema.Struct({
     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',
-  }),
+  Annotation.IconAnnotation.set({ icon: 'ph--shield-chevron--regular', hue: 'amber' }),
+  BlueprintsAnnotation.set([BLUEPRINT_KEY]),
+  // Implementation detail of the unified `Game` schema. The user-facing object is `Game`;
+  // this state is only ever referenced via `Game.variant`. HiddenAnnotation keeps it out of the
+  // navtree's typed branches so an orphaned state object doesn't reappear after the
+  // wrapping Game is deleted.
+  HiddenAnnotation.set(true),
+  Type.makeObject(DXN.make('org.dxos.type.chess.state', '0.1.0')),
 );
 
-export interface Game extends Schema.Schema.Type<typeof Game> {}
+export type State = Type.InstanceType<typeof State>;
 
-export const make = ({ name, pgn, fen }: { name?: string; pgn?: string; fen?: string } = {}) => {
+export const make = ({ pgn, fen }: { pgn?: string; fen?: string } = {}): State => {
   const chess = new ChessJS();
   if (pgn) {
     try {
@@ -53,10 +46,8 @@ export const make = ({ name, pgn, fen }: { name?: string; pgn?: string; fen?: st
     }
   }
 
-  return Obj.make(Game, {
-    name,
+  return Obj.make(State, {
     pgn,
     fen,
-    players: {},
   });
 };

package/src/{operations/definitions.ts → types/ChessOperation.ts}

@@ -2,49 +2,26 @@
 // Copyright 2025 DXOS.org
 //
 
-import * as Schema from 'effect/Schema';
+// @import-as-namespace
 
-import { Database, Ref } from '@dxos/echo';
-import { Operation } from '@dxos/operation';
+import * as Schema from 'effect/Schema';
 
-import { Chess } from '../types';
+import { Operation } from '@dxos/compute';
+import { Database, DXN } from '@dxos/echo';
+import { GameRef } from '@dxos/plugin-game';
 
-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],
-});
+import * as Chess from './Chess';
 
 export const Move = Operation.make({
   meta: {
-    key: 'org.dxos.function.chess.move',
+    key: DXN.make('org.dxos.function.chess.move'),
     name: 'Move',
     description: 'Makes a move in the given chess game.',
+    icon: 'ph--play--regular',
   },
   input: Schema.Struct({
-    game: Ref.Ref(Chess.Game).annotations({
-      description: 'The ID of the chess object.',
+    game: GameRef(Chess.State).annotations({
+      description: 'The ID of the game object (variant must be Chess).',
     }),
     move: Schema.String.annotations({
       description: 'The move to make in the chess game.',
@@ -61,13 +38,14 @@ export const Move = Operation.make({
 
 export const Play = Operation.make({
   meta: {
-    key: 'org.dxos.function.chess.play',
+    key: DXN.make('org.dxos.function.chess.play'),
     name: 'Play',
     description: 'Uses the chess engine to play the next move.',
+    icon: 'ph--play--regular',
   },
   input: Schema.Struct({
-    game: Ref.Ref(Chess.Game).annotations({
-      description: 'The ID of the chess object.',
+    game: GameRef(Chess.State).annotations({
+      description: 'The ID of the game object (variant must be Chess).',
     }),
     side: Schema.optional(Schema.Literal('white', 'black', 'any')).annotations({
       description: 'The side to play.',
@@ -87,9 +65,10 @@ export const Play = Operation.make({
 
 export const Print = Operation.make({
   meta: {
-    key: 'org.dxos.function.chess.print',
+    key: DXN.make('org.dxos.function.chess.print'),
     name: 'Print game',
     description: 'Prints the chess game to ASCII.',
+    icon: 'ph--clipboard-text--regular',
   },
   input: Schema.Struct({
     pgn: Schema.optional(

package/src/types/index.ts

@@ -3,3 +3,4 @@
 //
 
 export * as Chess from './Chess';
+export * as ChessOperation from './ChessOperation';

package/src/vite-env.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="vite/client" />
+
+//
+// Copyright 2026 DXOS.org
+//
+
+declare module '*.mdl?raw' {
+  const content: string;
+  export default content;
+}

package/dist/lib/browser/blueprints/index.mjs

@@ -1,14 +0,0 @@
-import {
-  chess_blueprint_default
-} from "../chunk-MC7L6JNC.mjs";
-import {
-  operations_exports
-} from "../chunk-JZMN24DY.mjs";
-import "../chunk-XAJZK6Z2.mjs";
-import "../chunk-2TJN26DN.mjs";
-import "../chunk-J5LGTIGS.mjs";
-export {
-  chess_blueprint_default as ChessBlueprint,
-  operations_exports as ChessFunctions
-};
-//# sourceMappingURL=index.mjs.map