@dxos/plugin-board 0.8.4-main.2e9d522 → 0.8.4-main.3eb6e50203

package/package.json

@@ -1,23 +1,29 @@
 {
   "name": "@dxos/plugin-board",
-  "version": "0.8.4-main.2e9d522",
+  "version": "0.8.4-main.3eb6e50203",
   "description": "Surface plugin for card baords",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "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"
+      "node": "./dist/lib/node-esm/index.mjs",
+      "source": "./src/index.ts",
+      "types": "./dist/types/src/index.d.ts"
     },
     "./types": {
-      "types": "./dist/types/src/types/index.d.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
-      "node": "./dist/lib/node-esm/types/index.mjs"
+      "node": "./dist/lib/node-esm/types/index.mjs",
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -33,53 +39,56 @@
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
-    "@preact/signals-react": "^3.2.0",
-    "effect": "3.17.0",
-    "@dxos/app-framework": "0.8.4-main.2e9d522",
-    "@dxos/assistant": "0.8.4-main.2e9d522",
-    "@dxos/async": "0.8.4-main.2e9d522",
-    "@dxos/blueprints": "0.8.4-main.2e9d522",
-    "@dxos/client": "0.8.4-main.2e9d522",
-    "@dxos/echo": "0.8.4-main.2e9d522",
-    "@dxos/echo-schema": "0.8.4-main.2e9d522",
-    "@dxos/effect": "0.8.4-main.2e9d522",
-    "@dxos/invariant": "0.8.4-main.2e9d522",
-    "@dxos/log": "0.8.4-main.2e9d522",
-    "@dxos/plugin-graph": "0.8.4-main.2e9d522",
-    "@dxos/plugin-search": "0.8.4-main.2e9d522",
-    "@dxos/plugin-space": "0.8.4-main.2e9d522",
-    "@dxos/random": "0.8.4-main.2e9d522",
-    "@dxos/react-client": "0.8.4-main.2e9d522",
-    "@dxos/react-ui": "0.8.4-main.2e9d522",
-    "@dxos/plugin-client": "0.8.4-main.2e9d522",
-    "@dxos/react-ui-board": "0.8.4-main.2e9d522",
-    "@dxos/react-ui-form": "0.8.4-main.2e9d522",
-    "@dxos/react-ui-stack": "0.8.4-main.2e9d522",
-    "@dxos/schema": "0.8.4-main.2e9d522",
-    "@dxos/util": "0.8.4-main.2e9d522",
-    "@dxos/ai": "0.8.4-main.2e9d522"
+    "effect": "3.19.16",
+    "@dxos/ai": "0.8.4-main.3eb6e50203",
+    "@dxos/app-framework": "0.8.4-main.3eb6e50203",
+    "@dxos/assistant": "0.8.4-main.3eb6e50203",
+    "@dxos/blueprints": "0.8.4-main.3eb6e50203",
+    "@dxos/async": "0.8.4-main.3eb6e50203",
+    "@dxos/client": "0.8.4-main.3eb6e50203",
+    "@dxos/echo": "0.8.4-main.3eb6e50203",
+    "@dxos/echo-react": "0.8.4-main.3eb6e50203",
+    "@dxos/effect": "0.8.4-main.3eb6e50203",
+    "@dxos/invariant": "0.8.4-main.3eb6e50203",
+    "@dxos/log": "0.8.4-main.3eb6e50203",
+    "@dxos/operation": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-client": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-search": "0.8.4-main.3eb6e50203",
+    "@dxos/app-toolkit": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-space": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-graph": "0.8.4-main.3eb6e50203",
+    "@dxos/random": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui-attention": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui-form": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui-board": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui-mosaic": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui-stack": "0.8.4-main.3eb6e50203",
+    "@dxos/schema": "0.8.4-main.3eb6e50203",
+    "@dxos/types": "0.8.4-main.3eb6e50203",
+    "@dxos/util": "0.8.4-main.3eb6e50203",
+    "@dxos/react-client": "0.8.4-main.3eb6e50203"
   },
   "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-preview": "0.8.4-main.2e9d522",
-    "@dxos/plugin-theme": "0.8.4-main.2e9d522",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.2e9d522",
-    "@dxos/react-ui-theme": "0.8.4-main.2e9d522",
-    "@dxos/storybook-utils": "0.8.4-main.2e9d522",
-    "@dxos/test-utils": "0.8.4-main.2e9d522"
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "7.1.9",
+    "@dxos/plugin-preview": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-testing": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.3eb6e50203",
+    "@dxos/storybook-utils": "0.8.4-main.3eb6e50203",
+    "@dxos/test-utils": "0.8.4-main.3eb6e50203",
+    "@dxos/ui-theme": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-theme": "0.8.4-main.3eb6e50203"
   },
   "peerDependencies": {
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui-theme": "0.8.4-main.2e9d522",
-    "@dxos/react-ui": "0.8.4-main.2e9d522"
+    "effect": "3.19.16",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.3eb6e50203",
+    "@dxos/ui-theme": "0.8.4-main.3eb6e50203"
   },
   "publishConfig": {
     "access": "public"

package/src/BoardPlugin.tsx

@@ -2,57 +2,32 @@
 // Copyright 2023 DXOS.org
 //
 
-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 * as Effect from 'effect/Effect';
+
+import { Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { type CreateObject } from '@dxos/plugin-space/types';
 import { translations as boardTranslations } from '@dxos/react-ui-board';
 
-import { IntentResolver, ReactSurface } from './capabilities';
+import { ReactSurface } from './capabilities';
 import { meta } from './meta';
 import { translations } from './translations';
 import { Board } from './types';
 
-export const BoardPlugin = () => {
-  return definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, [...translations, ...boardTranslations]),
-    }),
-    defineModule({
-      id: `${meta.id}/module/metadata`,
-      activatesOn: Events.SetupMetadata,
-      activate: () =>
-        // TODO(burdon): "Metadata" here seems non-descriptive; is this specifically for the type? ObjectMetadata?
-        contributes(Capabilities.Metadata, {
-          id: Board.Board.typename,
-          metadata: {
-            icon: 'ph--squares-four--regular',
-          },
-        }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/object-form`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () =>
-        contributes(
-          SpaceCapabilities.ObjectForm,
-          defineObjectForm({
-            objectSchema: Board.Board,
-            getIntent: () => createIntent(Board.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,
-    }),
-  ]);
-};
+export const BoardPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addMetadataModule({
+    metadata: {
+      id: Board.Board.typename,
+      metadata: {
+        icon: 'ph--squares-four--regular',
+        iconHue: 'green',
+        createObject: ((props) => Effect.sync(() => Board.makeBoard(props))) satisfies CreateObject,
+        addToCollectionOnCreate: true,
+      },
+    },
+  }),
+  AppPlugin.addSchemaModule({ schema: [Board.Board] }),
+  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addTranslationsModule({ translations: [...translations, ...boardTranslations] }),
+  Plugin.make,
+);

package/src/capabilities/index.ts

@@ -2,7 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
-
-export const IntentResolver = lazy(() => import('./intent-resolver'));
-export const ReactSurface = lazy(() => import('./react-surface'));
+export * from './react-surface';

package/src/capabilities/react-surface/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));

package/src/capabilities/react-surface/react-surface.tsx

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface } from '@dxos/app-framework/ui';
+import { Obj } from '@dxos/echo';
+
+import { BoardContainer } from '../../components';
+import { meta } from '../../meta';
+import { Board } from '../../types';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: meta.id,
+        role: ['article', 'section'],
+        filter: (data): data is { subject: Board.Board } => Obj.instanceOf(Board.Board, data.subject),
+        component: ({ role, data }) => <BoardContainer role={role} subject={data.subject} />,
+      }),
+    ]),
+  ),
+);

package/src/components/BoardContainer.stories.tsx

@@ -2,40 +2,30 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type StoryObj, type Meta } from '@storybook/react-vite';
+import { type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
 import React, { useEffect, useState } from 'react';
 
-import { IntentPlugin, SettingsPlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
 import { Obj } from '@dxos/echo';
 import { ClientPlugin } from '@dxos/plugin-client';
 import { PreviewPlugin } from '@dxos/plugin-preview';
-import { SpacePlugin } from '@dxos/plugin-space';
-import { StorybookLayoutPlugin } from '@dxos/plugin-storybook-layout';
-import { ThemePlugin } from '@dxos/plugin-theme';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
 import { faker } from '@dxos/random';
-import { type Client, useClient } from '@dxos/react-client';
-import { Filter, useSpaces, useQuery, Ref, type Space } from '@dxos/react-client/echo';
+import { Filter, Ref, useQuery, useSpaces } from '@dxos/react-client/echo';
+import { withTheme } from '@dxos/react-ui/testing';
 import { translations as stackTranslations } from '@dxos/react-ui-stack';
-import { defaultTx } from '@dxos/react-ui-theme';
-import { DataType } from '@dxos/schema';
-import { withLayout } from '@dxos/storybook-utils';
+import { Organization, Person } from '@dxos/types';
 
-import { BoardContainer } from './BoardContainer';
 import { translations } from '../translations';
 import { Board } from '../types';
 
-faker.seed(0);
+import { BoardContainer } from './BoardContainer';
 
-//
-// Initialization utilities
-//
+faker.seed(0);
 
-const initializeBoard = async ({ space, client }: { space: Space; client: Client }) => {
-  // Create a new board
-  const board = Obj.make(Board.Board, {
+const createBoard = () =>
+  Obj.make(Board.Board, {
     name: 'Test Board',
     items: [],
     layout: {
@@ -44,28 +34,20 @@ const initializeBoard = async ({ space, client }: { space: Space; client: Client
     },
   });
 
-  return { board };
-};
-
-//
-// Story components
-//
-
-const rollOrg = () =>
-  ({
+const createOrg = () =>
+  Obj.make(Organization.Organization, {
     name: faker.commerce.productName(),
     description: faker.lorem.paragraph(),
     image: faker.image.url(),
     website: faker.internet.url(),
-    status: faker.helpers.arrayElement(DataType.OrganizationStatusOptions).id,
-    // TODO(thure): Why is this so difficult to type?
-  }) as unknown as DataType.Organization;
+    // TODO(burdon): Fix.
+    // status: faker.helpers.arrayElement(Organization.StatusOptions).id,
+  });
 
-const StorybookBoard = () => {
-  const _client = useClient();
+const DefaultStory = () => {
   const spaces = useSpaces();
   const space = spaces[spaces.length - 1];
-  const boards = useQuery(space, Filter.type(Board.Board));
+  const boards = useQuery(space?.db, Filter.type(Board.Board));
   const [board, setBoard] = useState<Board.Board>();
 
   useEffect(() => {
@@ -79,64 +61,61 @@ const StorybookBoard = () => {
     return null;
   }
 
-  return <BoardContainer role='board' board={board} />;
+  return <BoardContainer role='board' subject={board} />;
 };
 
-type StoryProps = {};
-
 //
 // Story definitions
 //
 
-const meta: Meta<StoryProps> = {
+const meta = {
   title: 'plugins/plugin-board/Board',
-  component: StorybookBoard,
-  render: () => <StorybookBoard />,
-  parameters: { translations: [...translations, ...stackTranslations] },
+  render: DefaultStory,
   decorators: [
-    withLayout({ fullscreen: true }),
+    withTheme(),
     withPluginManager({
       plugins: [
-        ThemePlugin({ tx: defaultTx }),
+        ...corePlugins(),
         ClientPlugin({
-          types: [DataType.Organization, DataType.Person, Board.Board],
-          onClientInitialized: async (_, client) => {
-            await client.halo.createIdentity();
-            const space = await client.spaces.create();
-            await space.waitUntilReady();
-            const { board } = await initializeBoard({
-              space,
-              client,
-            });
-            space.db.add(board);
-
-            // Add some sample items
-            Array.from({ length: 10 }).map((_, index) => {
-              const org = Obj.make(DataType.Organization, rollOrg());
-              space.db.add(org);
-              board.items.push(Ref.make(org));
-              board.layout.cells[org.id] = {
-                x: Math.floor(Math.random() * 5) - 2,
-                y: Math.floor(Math.random() * 5) - 2,
-                width: 1,
-                height: 1,
-              };
-              return org;
-            });
-          },
+          types: [Organization.Organization, Person.Person, Board.Board],
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* Effect.promise(() => client.halo.createIdentity());
+              const space = yield* Effect.promise(() => client.spaces.create());
+              yield* Effect.promise(() => space.waitUntilReady());
+              const board = space.db.add(createBoard());
+
+              Obj.change(board, (b) => {
+                // Add some sample items
+                Array.from({ length: 10 }).map(() => {
+                  const org = createOrg();
+                  space.db.add(org);
+                  b.items.push(Ref.make(org));
+                  b.layout.cells[org.id] = {
+                    x: Math.floor(Math.random() * 5) - 2,
+                    y: Math.floor(Math.random() * 5) - 2,
+                    width: 1,
+                    height: 1,
+                  };
+                  return org;
+                });
+              });
+            }),
         }),
-        StorybookLayoutPlugin(),
+
+        StorybookPlugin({}),
         PreviewPlugin(),
-        SpacePlugin(),
-        IntentPlugin(),
-        SettingsPlugin(),
       ],
     }),
   ],
+  parameters: {
+    layout: 'fullscreen',
+    translations: [...translations, ...stackTranslations],
+  },
 };
 
 export default meta;
 
-type Story = StoryObj<StoryProps>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {};