@dxos/plugin-board 0.8.4-main.9735255 → 0.8.4-main.9be5663bfe

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/plugin-board",
-  "version": "0.8.4-main.9735255",
+  "version": "0.8.4-main.9be5663bfe",
   "description": "Surface plugin for card baords",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -12,17 +12,24 @@
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
+  "imports": {
+    "#capabilities": "./src/capabilities/index.ts",
+    "#components": "./src/components/index.ts",
+    "#containers": "./src/containers/index.ts",
+    "#meta": "./src/meta.ts",
+    "#types": "./src/types/index.ts"
+  },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs",
-      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts"
     },
     "./types": {
+      "source": "./src/types/index.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
       "node": "./dist/lib/node-esm/types/index.mjs",
-      "source": "./src/types/index.ts",
       "types": "./dist/types/src/types/index.d.ts"
     }
   },
@@ -39,55 +46,56 @@
     "src"
   ],
   "dependencies": {
-    "effect": "3.19.11",
-    "@dxos/ai": "0.8.4-main.9735255",
-    "@dxos/app-framework": "0.8.4-main.9735255",
-    "@dxos/async": "0.8.4-main.9735255",
-    "@dxos/assistant": "0.8.4-main.9735255",
-    "@dxos/client": "0.8.4-main.9735255",
-    "@dxos/blueprints": "0.8.4-main.9735255",
-    "@dxos/echo": "0.8.4-main.9735255",
-    "@dxos/effect": "0.8.4-main.9735255",
-    "@dxos/invariant": "0.8.4-main.9735255",
-    "@dxos/echo-react": "0.8.4-main.9735255",
-    "@dxos/plugin-client": "0.8.4-main.9735255",
-    "@dxos/log": "0.8.4-main.9735255",
-    "@dxos/operation": "0.8.4-main.9735255",
-    "@dxos/plugin-graph": "0.8.4-main.9735255",
-    "@dxos/plugin-search": "0.8.4-main.9735255",
-    "@dxos/random": "0.8.4-main.9735255",
-    "@dxos/plugin-space": "0.8.4-main.9735255",
-    "@dxos/react-client": "0.8.4-main.9735255",
-    "@dxos/react-ui": "0.8.4-main.9735255",
-    "@dxos/react-ui-attention": "0.8.4-main.9735255",
-    "@dxos/react-ui-board": "0.8.4-main.9735255",
-    "@dxos/react-ui-form": "0.8.4-main.9735255",
-    "@dxos/react-ui-stack": "0.8.4-main.9735255",
-    "@dxos/react-ui-mosaic": "0.8.4-main.9735255",
-    "@dxos/schema": "0.8.4-main.9735255",
-    "@dxos/types": "0.8.4-main.9735255",
-    "@dxos/util": "0.8.4-main.9735255"
+    "effect": "3.20.0",
+    "@dxos/ai": "0.8.4-main.9be5663bfe",
+    "@dxos/app-framework": "0.8.4-main.9be5663bfe",
+    "@dxos/app-toolkit": "0.8.4-main.9be5663bfe",
+    "@dxos/assistant": "0.8.4-main.9be5663bfe",
+    "@dxos/async": "0.8.4-main.9be5663bfe",
+    "@dxos/blueprints": "0.8.4-main.9be5663bfe",
+    "@dxos/echo": "0.8.4-main.9be5663bfe",
+    "@dxos/client": "0.8.4-main.9be5663bfe",
+    "@dxos/invariant": "0.8.4-main.9be5663bfe",
+    "@dxos/echo-react": "0.8.4-main.9be5663bfe",
+    "@dxos/effect": "0.8.4-main.9be5663bfe",
+    "@dxos/log": "0.8.4-main.9be5663bfe",
+    "@dxos/plugin-client": "0.8.4-main.9be5663bfe",
+    "@dxos/plugin-search": "0.8.4-main.9be5663bfe",
+    "@dxos/plugin-graph": "0.8.4-main.9be5663bfe",
+    "@dxos/operation": "0.8.4-main.9be5663bfe",
+    "@dxos/random": "0.8.4-main.9be5663bfe",
+    "@dxos/plugin-space": "0.8.4-main.9be5663bfe",
+    "@dxos/react-client": "0.8.4-main.9be5663bfe",
+    "@dxos/react-ui-board": "0.8.4-main.9be5663bfe",
+    "@dxos/react-ui-form": "0.8.4-main.9be5663bfe",
+    "@dxos/react-ui-stack": "0.8.4-main.9be5663bfe",
+    "@dxos/react-ui-mosaic": "0.8.4-main.9be5663bfe",
+    "@dxos/schema": "0.8.4-main.9be5663bfe",
+    "@dxos/util": "0.8.4-main.9be5663bfe",
+    "@dxos/types": "0.8.4-main.9be5663bfe",
+    "@dxos/react-ui-attention": "0.8.4-main.9be5663bfe",
+    "@dxos/react-ui": "0.8.4-main.9be5663bfe"
   },
   "devDependencies": {
     "@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-testing": "0.8.4-main.9735255",
-    "@dxos/plugin-preview": "0.8.4-main.9735255",
-    "@dxos/plugin-theme": "0.8.4-main.9735255",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.9735255",
-    "@dxos/storybook-utils": "0.8.4-main.9735255",
-    "@dxos/test-utils": "0.8.4-main.9735255",
-    "@dxos/ui-theme": "0.8.4-main.9735255"
+    "vite": "^7.1.11",
+    "@dxos/plugin-preview": "0.8.4-main.9be5663bfe",
+    "@dxos/plugin-testing": "0.8.4-main.9be5663bfe",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.9be5663bfe",
+    "@dxos/plugin-theme": "0.8.4-main.9be5663bfe",
+    "@dxos/storybook-utils": "0.8.4-main.9be5663bfe",
+    "@dxos/test-utils": "0.8.4-main.9be5663bfe",
+    "@dxos/ui-theme": "0.8.4-main.9be5663bfe"
   },
   "peerDependencies": {
-    "effect": "3.19.11",
+    "effect": "3.20.0",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
-    "@dxos/react-ui": "0.8.4-main.9735255",
-    "@dxos/ui-theme": "0.8.4-main.9735255"
+    "@dxos/react-ui": "0.8.4-main.9be5663bfe",
+    "@dxos/ui-theme": "0.8.4-main.9be5663bfe"
   },
   "publishConfig": {
     "access": "public"

package/src/BoardPlugin.tsx

@@ -3,30 +3,44 @@
 //
 
 import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
 
-import { Common, Plugin } from '@dxos/app-framework';
+import { Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { Annotation } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+import { SpaceOperation } from '@dxos/plugin-space/operations';
 import { type CreateObject } from '@dxos/plugin-space/types';
 import { translations as boardTranslations } from '@dxos/react-ui-board';
 
-import { ReactSurface } from './capabilities';
-import { meta } from './meta';
+import { ReactSurface } from '#capabilities';
+import { meta } from '#meta';
+import { Board } from '#types';
+
 import { translations } from './translations';
-import { Board } from './types';
 
 export const BoardPlugin = Plugin.define(meta).pipe(
-  Common.Plugin.addTranslationsModule({ translations: [...translations, ...boardTranslations] }),
-  Common.Plugin.addMetadataModule({
+  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,
+        icon: Annotation.IconAnnotation.get(Board.Board).pipe(Option.getOrThrow).icon,
+        iconHue: Annotation.IconAnnotation.get(Board.Board).pipe(Option.getOrThrow).hue ?? 'white',
+        createObject: ((props, options) =>
+          Effect.gen(function* () {
+            const object = Board.makeBoard(props);
+            return yield* Operation.invoke(SpaceOperation.AddObject, {
+              object,
+              target: options.target,
+              hidden: true,
+              targetNodeId: options.targetNodeId,
+            });
+          })) satisfies CreateObject,
       },
     },
   }),
-  Common.Plugin.addSchemaModule({ schema: [Board.Board] }),
-  Common.Plugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addSchemaModule({ schema: [Board.Board] }),
+  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addTranslationsModule({ translations: [...translations, ...boardTranslations] }),
   Plugin.make,
 );

package/src/capabilities/index.ts

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

package/src/capabilities/react-surface.tsx

@@ -0,0 +1,29 @@
+//
+// 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 { AppSurface } from '@dxos/app-toolkit/ui';
+
+import { BoardContainer } from '#containers';
+import { Board } from '#types';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: 'root',
+        // TODO(wittjosiah): Split into multiple surfaces if this filter proves too strict for non-article roles.
+        role: ['article', 'section'],
+        filter: AppSurface.objectArticle(Board.Board),
+        component: ({ role, data }) => (
+          <BoardContainer role={role} subject={data.subject} attendableId={data.attendableId} />
+        ),
+      }),
+    ]),
+  ),
+);

package/src/components/index.ts

@@ -1,5 +1,3 @@
 //
 // Copyright 2024 DXOS.org
 //
-
-export * from './BoardContainer';

package/src/{components → containers/BoardContainer}/BoardContainer.stories.tsx

@@ -9,20 +9,21 @@ import React, { useEffect, useState } from 'react';
 import { withPluginManager } from '@dxos/app-framework/testing';
 import { Obj } from '@dxos/echo';
 import { ClientPlugin } from '@dxos/plugin-client';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
 import { PreviewPlugin } from '@dxos/plugin-preview';
 import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
-import { faker } from '@dxos/random';
+import { random } from '@dxos/random';
 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 { withLayout } from '@dxos/react-ui/testing';
 import { Organization, Person } from '@dxos/types';
 
-import { translations } from '../translations';
-import { Board } from '../types';
+import { Board } from '#types';
 
+import { translations } from '../../translations';
 import { BoardContainer } from './BoardContainer';
 
-faker.seed(0);
+random.seed(0);
 
 const createBoard = () =>
   Obj.make(Board.Board, {
@@ -36,12 +37,12 @@ const createBoard = () =>
 
 const createOrg = () =>
   Obj.make(Organization.Organization, {
-    name: faker.commerce.productName(),
-    description: faker.lorem.paragraph(),
-    image: faker.image.url(),
-    website: faker.internet.url(),
+    name: random.commerce.productName(),
+    description: random.lorem.paragraph(),
+    image: random.image.url(),
+    website: random.internet.url(),
     // TODO(burdon): Fix.
-    // status: faker.helpers.arrayElement(Organization.StatusOptions).id,
+    // status: random.helpers.arrayElement(Organization.StatusOptions).id,
   });
 
 const DefaultStory = () => {
@@ -61,7 +62,7 @@ const DefaultStory = () => {
     return null;
   }
 
-  return <BoardContainer role='board' subject={board} />;
+  return <BoardContainer role='board' subject={board} attendableId='test' />;
 };
 
 //
@@ -69,10 +70,10 @@ const DefaultStory = () => {
 //
 
 const meta = {
-  title: 'plugins/plugin-board/Board',
+  title: 'plugins/plugin-board/containers/BoardContainer',
   render: DefaultStory,
   decorators: [
-    withTheme,
+    withLayout({ layout: 'fullscreen' }),
     withPluginManager({
       plugins: [
         ...corePlugins(),
@@ -80,18 +81,18 @@ const meta = {
           types: [Organization.Organization, Person.Person, Board.Board],
           onClientInitialized: ({ client }) =>
             Effect.gen(function* () {
-              yield* Effect.promise(() => client.halo.createIdentity());
+              yield* initializeIdentity(client);
               const space = yield* Effect.promise(() => client.spaces.create());
               yield* Effect.promise(() => space.waitUntilReady());
               const board = space.db.add(createBoard());
 
-              Obj.change(board, (b) => {
+              Obj.change(board, (board) => {
                 // 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] = {
+                  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,

package/src/{components → containers/BoardContainer}/BoardContainer.tsx

@@ -4,18 +4,19 @@
 
 import React, { useCallback, useMemo, useRef, useState } from 'react';
 
-import { Surface, type SurfaceComponentProps } from '@dxos/app-framework/react';
+import { Surface } from '@dxos/app-framework/ui';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
 import { Filter, Obj, Ref } from '@dxos/echo';
 import { useObject, useObjects } from '@dxos/echo-react';
 import { invariant } from '@dxos/invariant';
 import { useQuery } from '@dxos/react-client/echo';
+import { Panel } 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 { Layout } from '@dxos/react-ui-mosaic';
 import { isNonNullable } from '@dxos/util';
 
-import { type Board as BoardType } from '../types';
+import { type Board as BoardType } from '#types';
 
 const DEFAULT_POSITION = { x: 0, y: 0 } satisfies Position;
 
@@ -23,15 +24,14 @@ type PickerState = {
   position: Position;
 };
 
-export type BoardContainerProps = SurfaceComponentProps<BoardType.Board>;
+export type BoardContainerProps = AppSurface.ObjectArticleProps<BoardType.Board>;
 
-export const BoardContainer = ({ role, subject: board }: BoardContainerProps) => {
+export const BoardContainer = ({ role, subject: board, attendableId }: BoardContainerProps) => {
   const controller = useRef<BoardController>(null);
   const [boardItems] = useObject(board, 'items');
   const items = useObjects(boardItems ?? []);
   const addTriggerRef = useRef<HTMLButtonElement | null>(null);
   const [pickerState, setPickerState] = useState<PickerState | null>(null);
-  const attendableId = Obj.getDXN(board).toString();
   const { hasAttention } = useAttention(attendableId);
 
   const db = Obj.getDatabase(board);
@@ -73,11 +73,11 @@ export const BoardContainer = ({ role, subject: board }: BoardContainerProps) =>
     (id) => {
       // TODO(burdon): Impl. DXN.equals and pass in DXN from `id`.
       const idx = board.items.findIndex((ref) => ref.dxn.asEchoDXN()?.echoId === id);
-      Obj.change(board, (b) => {
+      Obj.change(board, (board) => {
         if (idx !== -1) {
-          b.items.splice(idx, 1);
+          board.items.splice(idx, 1);
         }
-        delete b.layout.cells[id];
+        delete board.layout.cells[id];
       });
     },
     [board],
@@ -86,8 +86,8 @@ export const BoardContainer = ({ role, subject: board }: BoardContainerProps) =>
   const handleMove = useCallback<NonNullable<BoardRootProps['onMove']>>(
     (id, position) => {
       const layout = board.layout.cells[id];
-      Obj.change(board, (b) => {
-        b.layout.cells[id] = { ...layout, ...position };
+      Obj.change(board, (board) => {
+        board.layout.cells[id] = { ...layout, ...position };
       });
     },
     [board],
@@ -106,11 +106,11 @@ export const BoardContainer = ({ role, subject: board }: BoardContainerProps) =>
       }
 
       // Create a reference to the selected object and add it to the board.
-      Obj.change(board, (b) => {
-        b.items.push(Ref.make(selectedObject));
+      Obj.change(board, (board) => {
+        board.items.push(Ref.make(selectedObject));
 
         // Set the layout position for the new item.
-        b.layout.cells[selectedObject.id.toString()] = pickerState.position;
+        board.layout.cells[selectedObject.id.toString()] = pickerState.position;
       });
 
       // Close the picker.
@@ -127,22 +127,26 @@ export const BoardContainer = ({ role, subject: board }: BoardContainerProps) =>
           setPickerState(nextOpen ? { position: DEFAULT_POSITION } : null);
         }}
       >
-        <Layout.Main role={role} 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--content' data={{ subject: item }} limit={1} />
-                  </Board.Cell>
-                ))}
-              </Board.Content>
-            </Board.Viewport>
-          </Board.Container>
-        </Layout.Main>
-        <ObjectPicker.Content options={options} onSelect={handleSelect} classNames='popover-card-width' />
+        <Panel.Root role={role}>
+          <Panel.Toolbar asChild>
+            <Board.Toolbar disabled={!hasAttention} />
+          </Panel.Toolbar>
+          <Panel.Content asChild>
+            <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.Surface role='card--content' data={{ subject: item }} limit={1} />
+                    </Board.Cell>
+                  ))}
+                </Board.Content>
+              </Board.Viewport>
+            </Board.Container>
+          </Panel.Content>
+        </Panel.Root>
+        <ObjectPicker.Content options={options} onSelect={handleSelect} classNames='dx-card-popover-width' />
         <ObjectPicker.VirtualTrigger virtualRef={addTriggerRef} />
       </ObjectPicker.Root>
     </Board.Root>

package/src/containers/BoardContainer/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { BoardContainer as default } from './BoardContainer';

package/src/containers/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const BoardContainer: ComponentType<any> = lazy(() => import('./BoardContainer'));

package/src/index.ts

@@ -2,7 +2,6 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './components';
 export * from './meta';
 export * from './types';
 

package/src/meta.ts

@@ -6,7 +6,7 @@ import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
 export const meta: Plugin.Meta = {
-  id: 'dxos.org/plugin/board',
+  id: 'org.dxos.plugin.board',
   name: 'Board',
   description: trim`
     Infinite canvas workspace that combines sticky notes, media, and whiteboarding tools.

package/src/translations.ts

@@ -4,24 +4,25 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
-import { Board } from './types';
+import { meta } from '#meta';
+import { Board } from '#types';
 
 export const translations = [
   {
     'en-US': {
       [Board.Board.typename]: {
-        'typename label': 'Board',
-        'typename label_zero': 'Boards',
-        'typename label_one': 'Board',
-        'typename label_other': 'Boards',
-        'object name placeholder': 'New board',
-        'rename object label': 'Rename board',
-        'delete object label': 'Delete board',
-        'object deleted label': 'Board deleted',
+        'typename.label': 'Board',
+        'typename.label_zero': 'Boards',
+        'typename.label_one': 'Board',
+        'typename.label_other': 'Boards',
+        'object-name.placeholder': 'New board',
+        'add-object.label': 'Add board',
+        'rename-object.label': 'Rename board',
+        'delete-object.label': 'Delete board',
+        'object-deleted.label': 'Board deleted',
       },
       [meta.id]: {
-        'plugin name': 'Board',
+        'plugin.name': 'Board',
       },
     },
   },

package/src/types/Board.ts

@@ -4,7 +4,7 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Obj, Type } from '@dxos/echo';
+import { Annotation, Obj, Ref, Type } from '@dxos/echo';
 import { FormInputAnnotation, LabelAnnotation } from '@dxos/echo/internal';
 import { BoardLayout, defaultLayout } from '@dxos/react-ui-board';
 
@@ -13,14 +13,18 @@ import { BoardLayout, defaultLayout } from '@dxos/react-ui-board';
  */
 export const Board = Schema.Struct({
   name: Schema.String.pipe(Schema.optional),
-  items: Type.Ref(Type.Obj).pipe(Schema.Array, FormInputAnnotation.set(false)),
+  items: Ref.Ref(Obj.Unknown).pipe(Schema.Array, FormInputAnnotation.set(false)),
   layout: BoardLayout.pipe(FormInputAnnotation.set(false)),
 }).pipe(
   Type.object({
-    typename: 'dxos.org/type/Board',
+    typename: 'org.dxos.type.board',
     version: '0.1.0',
   }),
   LabelAnnotation.set(['name']),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--squares-four--regular',
+    hue: 'green',
+  }),
 );
 
 export interface Board extends Schema.Schema.Type<typeof Board> {}