@dxos/plugin-board 0.8.4-main.28f8d3d → 0.8.4-main.2c6827d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/plugin-board",
-  "version": "0.8.4-main.28f8d3d",
+  "version": "0.8.4-main.2c6827d",
   "description": "Surface plugin for card baords",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -36,52 +36,53 @@
   ],
   "dependencies": {
     "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
-    "@preact/signals-react": "^3.2.0",
-    "effect": "3.17.7",
-    "@dxos/ai": "0.8.4-main.28f8d3d",
-    "@dxos/app-framework": "0.8.4-main.28f8d3d",
-    "@dxos/assistant": "0.8.4-main.28f8d3d",
-    "@dxos/blueprints": "0.8.4-main.28f8d3d",
-    "@dxos/async": "0.8.4-main.28f8d3d",
-    "@dxos/echo": "0.8.4-main.28f8d3d",
-    "@dxos/echo-schema": "0.8.4-main.28f8d3d",
-    "@dxos/client": "0.8.4-main.28f8d3d",
-    "@dxos/effect": "0.8.4-main.28f8d3d",
-    "@dxos/invariant": "0.8.4-main.28f8d3d",
-    "@dxos/log": "0.8.4-main.28f8d3d",
-    "@dxos/plugin-client": "0.8.4-main.28f8d3d",
-    "@dxos/plugin-graph": "0.8.4-main.28f8d3d",
-    "@dxos/plugin-search": "0.8.4-main.28f8d3d",
-    "@dxos/random": "0.8.4-main.28f8d3d",
-    "@dxos/plugin-space": "0.8.4-main.28f8d3d",
-    "@dxos/react-ui": "0.8.4-main.28f8d3d",
-    "@dxos/react-ui-form": "0.8.4-main.28f8d3d",
-    "@dxos/react-client": "0.8.4-main.28f8d3d",
-    "@dxos/react-ui-stack": "0.8.4-main.28f8d3d",
-    "@dxos/react-ui-board": "0.8.4-main.28f8d3d",
-    "@dxos/schema": "0.8.4-main.28f8d3d",
-    "@dxos/util": "0.8.4-main.28f8d3d"
+    "@preact/signals-core": "^1.12.1",
+    "@preact/signals-react": "^3.3.0",
+    "effect": "3.18.3",
+    "@dxos/ai": "0.8.4-main.2c6827d",
+    "@dxos/assistant": "0.8.4-main.2c6827d",
+    "@dxos/blueprints": "0.8.4-main.2c6827d",
+    "@dxos/async": "0.8.4-main.2c6827d",
+    "@dxos/client": "0.8.4-main.2c6827d",
+    "@dxos/echo": "0.8.4-main.2c6827d",
+    "@dxos/effect": "0.8.4-main.2c6827d",
+    "@dxos/invariant": "0.8.4-main.2c6827d",
+    "@dxos/log": "0.8.4-main.2c6827d",
+    "@dxos/plugin-client": "0.8.4-main.2c6827d",
+    "@dxos/app-framework": "0.8.4-main.2c6827d",
+    "@dxos/plugin-space": "0.8.4-main.2c6827d",
+    "@dxos/random": "0.8.4-main.2c6827d",
+    "@dxos/react-ui": "0.8.4-main.2c6827d",
+    "@dxos/react-client": "0.8.4-main.2c6827d",
+    "@dxos/plugin-graph": "0.8.4-main.2c6827d",
+    "@dxos/react-ui-form": "0.8.4-main.2c6827d",
+    "@dxos/react-ui-board": "0.8.4-main.2c6827d",
+    "@dxos/react-ui-stack": "0.8.4-main.2c6827d",
+    "@dxos/plugin-search": "0.8.4-main.2c6827d",
+    "@dxos/schema": "0.8.4-main.2c6827d",
+    "@dxos/types": "0.8.4-main.2c6827d",
+    "@dxos/util": "0.8.4-main.2c6827d",
+    "@dxos/react-ui-attention": "0.8.4-main.2c6827d"
   },
   "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.28f8d3d",
-    "@dxos/plugin-theme": "0.8.4-main.28f8d3d",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.28f8d3d",
-    "@dxos/test-utils": "0.8.4-main.28f8d3d",
-    "@dxos/react-ui-theme": "0.8.4-main.28f8d3d",
-    "@dxos/storybook-utils": "0.8.4-main.28f8d3d"
+    "@types/react": "~19.2.2",
+    "@types/react-dom": "~19.2.2",
+    "react": "~19.2.0",
+    "react-dom": "~19.2.0",
+    "vite": "7.1.9",
+    "@dxos/plugin-preview": "0.8.4-main.2c6827d",
+    "@dxos/plugin-theme": "0.8.4-main.2c6827d",
+    "@dxos/react-ui-theme": "0.8.4-main.2c6827d",
+    "@dxos/test-utils": "0.8.4-main.2c6827d",
+    "@dxos/storybook-utils": "0.8.4-main.2c6827d",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.2c6827d"
   },
   "peerDependencies": {
     "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.28f8d3d",
-    "@dxos/react-ui-theme": "0.8.4-main.28f8d3d"
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "@dxos/react-ui-theme": "0.8.4-main.2c6827d",
+    "@dxos/react-ui": "0.8.4-main.2c6827d"
   },
   "publishConfig": {
     "access": "public"

package/src/BoardPlugin.tsx

@@ -13,46 +13,45 @@ 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',
-          },
+export const BoardPlugin = 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',
+          iconHue: 'green',
+        },
+      }),
+  }),
+  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/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,
-    }),
-  ]);
-};
+      ),
+  }),
+  defineModule({
+    id: `${meta.id}/module/react-surface`,
+    activatesOn: Events.SetupReactSurface,
+    activate: ReactSurface,
+  }),
+  defineModule({
+    id: `${meta.id}/module/intent-resolver`,
+    activatesOn: Events.SetupIntentResolver,
+    activate: IntentResolver,
+  }),
+]);

package/src/components/BoardContainer.stories.tsx

@@ -2,9 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
+import { type StoryObj } from '@storybook/react-vite';
 import React, { useEffect, useState } from 'react';
 
 import { IntentPlugin, SettingsPlugin } from '@dxos/app-framework';
@@ -16,12 +14,11 @@ import { SpacePlugin } from '@dxos/plugin-space';
 import { StorybookLayoutPlugin } from '@dxos/plugin-storybook-layout';
 import { ThemePlugin } from '@dxos/plugin-theme';
 import { faker } from '@dxos/random';
-import { type Client, useClient } from '@dxos/react-client';
-import { Filter, Ref, type Space, useQuery, useSpaces } 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 { translations } from '../translations';
 import { Board } from '../types';
@@ -30,13 +27,8 @@ import { BoardContainer } from './BoardContainer';
 
 faker.seed(0);
 
-//
-// Initialization utilities
-//
-
-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: {
@@ -45,25 +37,17 @@ 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));
@@ -83,37 +67,28 @@ const StorybookBoard = () => {
   return <BoardContainer role='board' board={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 }),
         ClientPlugin({
-          types: [DataType.Organization, DataType.Person, Board.Board],
+          types: [Organization.Organization, Person.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);
+            const board = space.db.add(createBoard());
 
             // Add some sample items
             Array.from({ length: 10 }).map(() => {
-              const org = Obj.make(DataType.Organization, rollOrg());
+              const org = createOrg();
               space.db.add(org);
               board.items.push(Ref.make(org));
               board.layout.cells[org.id] = {
@@ -126,18 +101,25 @@ const meta: Meta<StoryProps> = {
             });
           },
         }),
-        StorybookLayoutPlugin(),
-        PreviewPlugin(),
-        SpacePlugin(),
+        SpacePlugin({}),
         IntentPlugin(),
         SettingsPlugin(),
+
+        // UI
+        ThemePlugin({ tx: defaultTx }),
+        PreviewPlugin(),
+        StorybookLayoutPlugin({}),
       ],
     }),
   ],
+  parameters: {
+    layout: 'fullscreen',
+    translations: [...translations, ...stackTranslations],
+  },
 };
 
 export default meta;
 
-type Story = StoryObj<StoryProps>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {};

package/src/components/BoardContainer.tsx

@@ -2,62 +2,72 @@
 // Copyright 2025 DXOS.org
 //
 
-import { effect } from '@preact/signals-react';
-import React, { useCallback, useEffect, useRef, useState } from 'react';
+import React, { useCallback, useMemo, useRef, useState } from 'react';
 
-import { Surface, createIntent, useIntentDispatcher } from '@dxos/app-framework';
+import { Surface } from '@dxos/app-framework/react';
 import { getSpace } from '@dxos/client/echo';
-import { type Obj, Ref, type Type } from '@dxos/echo';
+import { Filter, Obj, Ref } from '@dxos/echo';
 import { invariant } from '@dxos/invariant';
-import { SpaceAction } from '@dxos/plugin-space/types';
-import { Board, type BoardController, type BoardRootProps } from '@dxos/react-ui-board';
+import { useQuery } from '@dxos/react-client/echo';
+import { useSignalsMemo } from '@dxos/react-ui';
+import { useAttention } from '@dxos/react-ui-attention';
+import { Board, type BoardController, type BoardRootProps, type Position } from '@dxos/react-ui-board';
+import { ObjectPicker, type ObjectPickerContentProps } from '@dxos/react-ui-form';
 import { StackItem } from '@dxos/react-ui-stack';
 import { isNonNullable } from '@dxos/util';
 
-// TODO(thure): There is debate about having to rename either the type or the React component. A best practice should be chosen and either Board or Kanban (or both) should be refactored to apply it.
 import { type Board as BoardType } from '../types';
 
+const DEFAULT_POSITION = { x: 0, y: 0 } satisfies Position;
+
+type PickerState = {
+  position: Position;
+};
+
 export type BoardContainerProps = {
   role?: string;
   board: BoardType.Board;
 };
 
-export const BoardContainer = ({ role, board }: BoardContainerProps) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
+export const BoardContainer = ({ board }: BoardContainerProps) => {
   const controller = useRef<BoardController>(null);
+  const items = useSignalsMemo(() => board.items.map((ref) => ref.target).filter(isNonNullable), [board]);
+  const addTriggerRef = useRef<HTMLButtonElement | null>(null);
+  const [pickerState, setPickerState] = useState<PickerState | null>(null);
+  const attendableId = Obj.getDXN(board).toString();
+  const { hasAttention } = useAttention(attendableId);
 
-  // TODO(burdon): Create effect utility for reactive arrays.
-  const [items, setItems] = useState<Type.Expando[]>([]);
-  useEffect(() => {
-    let t: NodeJS.Timeout;
-    effect(() => {
-      const refs = [...board.items];
-      t = setTimeout(async () => {
-        const items = await Ref.Array.loadAll(refs);
-        setItems(items.filter(isNonNullable));
-      });
-    });
-
-    return () => clearTimeout(t);
-  }, [board.items]);
+  // TODO(burdon): Use search.
+  const objects = useQuery(getSpace(board), Filter.everything());
+  const options = useMemo<ObjectPickerContentProps['options']>(
+    () =>
+      objects
+        .filter((obj) => obj.id !== board.id)
+        .map((obj) => {
+          const label = Obj.getLabel(obj);
+          if (label) {
+            return {
+              id: obj.id,
+              label,
+              hue: 'neutral' as const,
+            };
+          }
+        })
+        .filter(isNonNullable)
+        .sort(({ label: a }, { label: b }) => a.toLocaleLowerCase().localeCompare(b.toLocaleLowerCase())),
+    [objects],
+  );
 
   const handleAdd = useCallback<NonNullable<BoardRootProps['onAdd']>>(
-    async (position = { x: 0, y: 0 }) => {
+    async (anchor, position = DEFAULT_POSITION) => {
       const space = getSpace(board);
       invariant(space);
-      await dispatch(
-        createIntent(SpaceAction.OpenCreateObject, {
-          target: space,
-          navigable: false,
-          onCreateObject: (object: Obj.Any) => {
-            board.items.push(Ref.make(object));
-            board.layout.cells[object.id] = { ...position, width: 1, height: 1 };
-            controller.current?.center(position);
-          },
-        }),
-      );
+      addTriggerRef.current = anchor;
+      setPickerState({
+        position,
+      });
     },
-    [board, controller, dispatch],
+    [board],
   );
 
   // TODO(burdon): Use intents so can be undone.
@@ -69,7 +79,6 @@ export const BoardContainer = ({ role, board }: BoardContainerProps) => {
         board.items.splice(idx, 1);
       }
       delete board.layout.cells[id];
-      setItems((items) => items.filter((item) => item.id !== id));
     },
     [board],
   );
@@ -82,23 +91,56 @@ export const BoardContainer = ({ role, board }: BoardContainerProps) => {
     [board],
   );
 
+  const handleSelect = useCallback<NonNullable<ObjectPickerContentProps['onSelect']>>(
+    (id) => {
+      if (!pickerState) {
+        return;
+      }
+
+      // Find the selected object by id from the space.
+      const selectedObject = objects.find((obj) => obj.id === id);
+      if (!selectedObject) {
+        return;
+      }
+
+      // Create a reference to the selected object and add it to the board.
+      board.items.push(Ref.make(selectedObject));
+
+      // Set the layout position for the new item.
+      board.layout.cells[selectedObject.id.toString()] = pickerState.position;
+
+      // Close the picker.
+      setPickerState(null);
+    },
+    [pickerState, objects, board],
+  );
+
   return (
     <Board.Root ref={controller} layout={board.layout} onAdd={handleAdd} onDelete={handleDelete} onMove={handleMove}>
-      <StackItem.Content toolbar classNames='overflow-hidden'>
-        <Board.Toolbar />
-        <Board.Container>
-          <Board.Viewport classNames='border-none'>
-            <Board.Backdrop />
-            <Board.Content>
-              {items?.map((item, index) => (
-                <Board.Cell item={item} key={index} layout={board.layout?.cells[item.id] ?? { x: 0, y: 0 }}>
-                  <Surface role='card--extrinsic' data={{ subject: item }} limit={1} />
-                </Board.Cell>
-              ))}
-            </Board.Content>
-          </Board.Viewport>
-        </Board.Container>
-      </StackItem.Content>
+      <ObjectPicker.Root
+        open={!!pickerState}
+        onOpenChange={(nextOpen: boolean) => {
+          setPickerState(nextOpen ? { position: DEFAULT_POSITION } : null);
+        }}
+      >
+        <StackItem.Content toolbar>
+          <Board.Toolbar disabled={!hasAttention} />
+          <Board.Container>
+            <Board.Viewport classNames='border-none'>
+              <Board.Backdrop />
+              <Board.Content>
+                {items?.map((item, index) => (
+                  <Board.Cell item={item} key={index} layout={board.layout?.cells[item.id] ?? { x: 0, y: 0 }}>
+                    <Surface role='card--extrinsic' data={{ subject: item }} limit={1} />
+                  </Board.Cell>
+                ))}
+              </Board.Content>
+            </Board.Viewport>
+          </Board.Container>
+        </StackItem.Content>
+        <ObjectPicker.Content options={options} onSelect={handleSelect} classNames='popover-card-width' />
+        <ObjectPicker.VirtualTrigger virtualRef={addTriggerRef} />
+      </ObjectPicker.Root>
     </Board.Root>
   );
 };

package/src/meta.ts

@@ -3,13 +3,17 @@
 //
 
 import { type PluginMeta } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
 export const meta: PluginMeta = {
   id: 'dxos.org/plugin/board',
   name: 'Board',
-  description:
-    'A spatial, infinite canvas app combining notes, media, and whiteboarding in a tactile, visual interface.',
+  description: trim`
+    Infinite canvas workspace that combines sticky notes, media, and whiteboarding tools.
+    Arrange and connect ideas freely in a visual space perfect for brainstorming and creative collaboration.
+  `,
   icon: 'ph--squares-four--regular',
+  iconHue: 'green',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-board',
   screenshots: [],
 };

package/src/types/Board.ts

@@ -2,10 +2,10 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 import { Obj, Type } from '@dxos/echo';
-import { LabelAnnotation } from '@dxos/echo-schema';
+import { FormAnnotation, LabelAnnotation } from '@dxos/echo/internal';
 import { BoardLayout, defaultLayout } from '@dxos/react-ui-board';
 
 import { meta } from '../meta';
@@ -14,9 +14,9 @@ import { meta } from '../meta';
  * Board and layout.
  */
 export const Board = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  items: Schema.mutable(Schema.Array(Type.Ref(Type.Expando))),
-  layout: Schema.mutable(BoardLayout),
+  name: Schema.String.pipe(Schema.optional),
+  items: Type.Ref(Type.Expando).pipe(Schema.Array, Schema.mutable, FormAnnotation.set(false)),
+  layout: BoardLayout.pipe(Schema.mutable, FormAnnotation.set(false)),
 }).pipe(
   Type.Obj({
     typename: 'dxos.org/type/Board',