@dxos/plugin-board 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/dist/lib/browser/chunk-FL67SBF5.mjs +39 -0
  2. package/dist/lib/browser/chunk-FL67SBF5.mjs.map +7 -0
  3. package/dist/lib/browser/index.mjs +70 -62
  4. package/dist/lib/browser/index.mjs.map +4 -4
  5. package/dist/lib/browser/meta.json +1 -1
  6. package/dist/lib/browser/types/index.mjs +3 -3
  7. package/dist/lib/node-esm/chunk-5GGKJL4Z.mjs +40 -0
  8. package/dist/lib/node-esm/chunk-5GGKJL4Z.mjs.map +7 -0
  9. package/dist/lib/node-esm/index.mjs +70 -62
  10. package/dist/lib/node-esm/index.mjs.map +4 -4
  11. package/dist/lib/node-esm/meta.json +1 -1
  12. package/dist/lib/node-esm/types/index.mjs +3 -3
  13. package/dist/types/src/BoardPlugin.d.ts +2 -1
  14. package/dist/types/src/BoardPlugin.d.ts.map +1 -1
  15. package/dist/types/src/capabilities/index.d.ts +2 -2
  16. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  17. package/dist/types/src/capabilities/react-surface.d.ts +3 -2
  18. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
  19. package/dist/types/src/components/index.d.ts +0 -1
  20. package/dist/types/src/components/index.d.ts.map +1 -1
  21. package/dist/types/src/containers/BoardContainer/BoardContainer.d.ts +6 -0
  22. package/dist/types/src/containers/BoardContainer/BoardContainer.d.ts.map +1 -0
  23. package/dist/types/src/containers/BoardContainer/BoardContainer.stories.d.ts +47 -0
  24. package/dist/types/src/containers/BoardContainer/BoardContainer.stories.d.ts.map +1 -0
  25. package/dist/types/src/containers/BoardContainer/index.d.ts +2 -0
  26. package/dist/types/src/containers/BoardContainer/index.d.ts.map +1 -0
  27. package/dist/types/src/containers/index.d.ts +3 -0
  28. package/dist/types/src/containers/index.d.ts.map +1 -0
  29. package/dist/types/src/index.d.ts +1 -0
  30. package/dist/types/src/index.d.ts.map +1 -1
  31. package/dist/types/src/meta.d.ts +2 -2
  32. package/dist/types/src/meta.d.ts.map +1 -1
  33. package/dist/types/src/translations.d.ts +12 -8
  34. package/dist/types/src/translations.d.ts.map +1 -1
  35. package/dist/types/src/types/Board.d.ts +46 -0
  36. package/dist/types/src/types/Board.d.ts.map +1 -0
  37. package/dist/types/src/types/index.d.ts +1 -1
  38. package/dist/types/src/types/index.d.ts.map +1 -1
  39. package/dist/types/tsconfig.tsbuildinfo +1 -1
  40. package/package.json +66 -50
  41. package/src/BoardPlugin.tsx +38 -50
  42. package/src/capabilities/index.ts +2 -3
  43. package/src/capabilities/react-surface.tsx +23 -14
  44. package/src/components/index.ts +0 -2
  45. package/src/containers/BoardContainer/BoardContainer.stories.tsx +122 -0
  46. package/src/containers/BoardContainer/BoardContainer.tsx +154 -0
  47. package/src/containers/BoardContainer/index.ts +5 -0
  48. package/src/containers/index.ts +7 -0
  49. package/src/index.ts +1 -0
  50. package/src/meta.ts +9 -5
  51. package/src/translations.ts +12 -8
  52. package/src/types/Board.ts +37 -0
  53. package/src/types/index.ts +1 -1
  54. package/dist/lib/browser/chunk-TDV6SJ64.mjs +0 -46
  55. package/dist/lib/browser/chunk-TDV6SJ64.mjs.map +0 -7
  56. package/dist/lib/browser/intent-resolver-TDOZP647.mjs +0 -33
  57. package/dist/lib/browser/intent-resolver-TDOZP647.mjs.map +0 -7
  58. package/dist/lib/browser/react-surface-SHXN2B3I.mjs +0 -125
  59. package/dist/lib/browser/react-surface-SHXN2B3I.mjs.map +0 -7
  60. package/dist/lib/node-esm/chunk-K6CHLZYU.mjs +0 -48
  61. package/dist/lib/node-esm/chunk-K6CHLZYU.mjs.map +0 -7
  62. package/dist/lib/node-esm/intent-resolver-IHQWKJNT.mjs +0 -34
  63. package/dist/lib/node-esm/intent-resolver-IHQWKJNT.mjs.map +0 -7
  64. package/dist/lib/node-esm/react-surface-DGFWUKUE.mjs +0 -126
  65. package/dist/lib/node-esm/react-surface-DGFWUKUE.mjs.map +0 -7
  66. package/dist/types/src/capabilities/intent-resolver.d.ts +0 -4
  67. package/dist/types/src/capabilities/intent-resolver.d.ts.map +0 -1
  68. package/dist/types/src/components/BoardContainer.d.ts +0 -8
  69. package/dist/types/src/components/BoardContainer.d.ts.map +0 -1
  70. package/dist/types/src/types/schema.d.ts +0 -65
  71. package/dist/types/src/types/schema.d.ts.map +0 -1
  72. package/src/capabilities/intent-resolver.ts +0 -34
  73. package/src/components/BoardContainer.tsx +0 -94
  74. package/src/types/schema.ts +0 -45
package/package.json CHANGED
@@ -1,30 +1,43 @@
1
1
  {
2
2
  "name": "@dxos/plugin-board",
3
- "version": "0.8.4-main.f9ba587",
3
+ "version": "0.8.4-main.fcfe5033a5",
4
4
  "description": "Surface plugin for card baords",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/dxos/dxos"
10
+ },
7
11
  "license": "MIT",
8
12
  "author": "DXOS.org",
9
13
  "sideEffects": true,
10
14
  "type": "module",
15
+ "imports": {
16
+ "#capabilities": "./src/capabilities/index.ts",
17
+ "#components": "./src/components/index.ts",
18
+ "#containers": "./src/containers/index.ts",
19
+ "#meta": "./src/meta.ts",
20
+ "#types": "./src/types/index.ts"
21
+ },
11
22
  "exports": {
12
23
  ".": {
13
- "types": "./dist/types/src/index.d.ts",
24
+ "source": "./src/index.ts",
14
25
  "browser": "./dist/lib/browser/index.mjs",
15
- "node": "./dist/lib/node-esm/index.mjs"
26
+ "node": "./dist/lib/node-esm/index.mjs",
27
+ "types": "./dist/types/src/index.d.ts"
16
28
  },
17
29
  "./types": {
18
- "types": "./dist/types/src/types.d.ts",
19
- "browser": "./dist/lib/browser/types.mjs",
20
- "node": "./dist/lib/node-esm/types.mjs"
30
+ "source": "./src/types/index.ts",
31
+ "browser": "./dist/lib/browser/types/index.mjs",
32
+ "node": "./dist/lib/node-esm/types/index.mjs",
33
+ "types": "./dist/types/src/types/index.d.ts"
21
34
  }
22
35
  },
23
36
  "types": "dist/types/src/index.d.ts",
24
37
  "typesVersions": {
25
38
  "*": {
26
39
  "types": [
27
- "dist/types/src/types.d.ts"
40
+ "dist/types/src/types/index.d.ts"
28
41
  ]
29
42
  }
30
43
  },
@@ -33,53 +46,56 @@
33
46
  "src"
34
47
  ],
35
48
  "dependencies": {
36
- "@preact-signals/safe-react": "^0.9.0",
37
- "@preact/signals-core": "^1.9.0",
38
- "@preact/signals-react": "^3.2.0",
39
- "effect": "3.16.13",
40
- "@dxos/ai": "0.8.4-main.f9ba587",
41
- "@dxos/artifact": "0.8.4-main.f9ba587",
42
- "@dxos/app-framework": "0.8.4-main.f9ba587",
43
- "@dxos/assistant": "0.8.4-main.f9ba587",
44
- "@dxos/async": "0.8.4-main.f9ba587",
45
- "@dxos/echo": "0.8.4-main.f9ba587",
46
- "@dxos/echo-schema": "0.8.4-main.f9ba587",
47
- "@dxos/effect": "0.8.4-main.f9ba587",
48
- "@dxos/client": "0.8.4-main.f9ba587",
49
- "@dxos/invariant": "0.8.4-main.f9ba587",
50
- "@dxos/log": "0.8.4-main.f9ba587",
51
- "@dxos/plugin-client": "0.8.4-main.f9ba587",
52
- "@dxos/plugin-graph": "0.8.4-main.f9ba587",
53
- "@dxos/plugin-search": "0.8.4-main.f9ba587",
54
- "@dxos/plugin-space": "0.8.4-main.f9ba587",
55
- "@dxos/random": "0.8.4-main.f9ba587",
56
- "@dxos/react-client": "0.8.4-main.f9ba587",
57
- "@dxos/react-ui": "0.8.4-main.f9ba587",
58
- "@dxos/react-ui-board": "0.8.4-main.f9ba587",
59
- "@dxos/react-ui-form": "0.8.4-main.f9ba587",
60
- "@dxos/react-ui-stack": "0.8.4-main.f9ba587",
61
- "@dxos/schema": "0.8.4-main.f9ba587",
62
- "@dxos/util": "0.8.4-main.f9ba587"
49
+ "effect": "3.20.0",
50
+ "@dxos/app-toolkit": "0.8.4-main.fcfe5033a5",
51
+ "@dxos/ai": "0.8.4-main.fcfe5033a5",
52
+ "@dxos/assistant": "0.8.4-main.fcfe5033a5",
53
+ "@dxos/async": "0.8.4-main.fcfe5033a5",
54
+ "@dxos/blueprints": "0.8.4-main.fcfe5033a5",
55
+ "@dxos/app-framework": "0.8.4-main.fcfe5033a5",
56
+ "@dxos/client": "0.8.4-main.fcfe5033a5",
57
+ "@dxos/echo": "0.8.4-main.fcfe5033a5",
58
+ "@dxos/effect": "0.8.4-main.fcfe5033a5",
59
+ "@dxos/invariant": "0.8.4-main.fcfe5033a5",
60
+ "@dxos/log": "0.8.4-main.fcfe5033a5",
61
+ "@dxos/plugin-client": "0.8.4-main.fcfe5033a5",
62
+ "@dxos/operation": "0.8.4-main.fcfe5033a5",
63
+ "@dxos/plugin-search": "0.8.4-main.fcfe5033a5",
64
+ "@dxos/plugin-space": "0.8.4-main.fcfe5033a5",
65
+ "@dxos/plugin-graph": "0.8.4-main.fcfe5033a5",
66
+ "@dxos/random": "0.8.4-main.fcfe5033a5",
67
+ "@dxos/echo-react": "0.8.4-main.fcfe5033a5",
68
+ "@dxos/react-client": "0.8.4-main.fcfe5033a5",
69
+ "@dxos/react-ui": "0.8.4-main.fcfe5033a5",
70
+ "@dxos/react-ui-attention": "0.8.4-main.fcfe5033a5",
71
+ "@dxos/react-ui-form": "0.8.4-main.fcfe5033a5",
72
+ "@dxos/react-ui-mosaic": "0.8.4-main.fcfe5033a5",
73
+ "@dxos/react-ui-board": "0.8.4-main.fcfe5033a5",
74
+ "@dxos/react-ui-stack": "0.8.4-main.fcfe5033a5",
75
+ "@dxos/schema": "0.8.4-main.fcfe5033a5",
76
+ "@dxos/types": "0.8.4-main.fcfe5033a5",
77
+ "@dxos/util": "0.8.4-main.fcfe5033a5"
63
78
  },
64
79
  "devDependencies": {
65
- "@types/react": "~18.2.0",
66
- "@types/react-dom": "~18.2.0",
67
- "react": "~18.2.0",
68
- "react-dom": "~18.2.0",
69
- "vite": "5.4.7",
70
- "@dxos/plugin-preview": "0.8.4-main.f9ba587",
71
- "@dxos/plugin-theme": "0.8.4-main.f9ba587",
72
- "@dxos/react-ui-syntax-highlighter": "0.8.4-main.f9ba587",
73
- "@dxos/react-ui-theme": "0.8.4-main.f9ba587",
74
- "@dxos/storybook-utils": "0.8.4-main.f9ba587",
75
- "@dxos/test-utils": "0.8.4-main.f9ba587"
80
+ "@types/react": "~19.2.7",
81
+ "@types/react-dom": "~19.2.3",
82
+ "react": "~19.2.3",
83
+ "react-dom": "~19.2.3",
84
+ "vite": "^7.1.11",
85
+ "@dxos/plugin-preview": "0.8.4-main.fcfe5033a5",
86
+ "@dxos/plugin-testing": "0.8.4-main.fcfe5033a5",
87
+ "@dxos/plugin-theme": "0.8.4-main.fcfe5033a5",
88
+ "@dxos/react-ui-syntax-highlighter": "0.8.4-main.fcfe5033a5",
89
+ "@dxos/storybook-utils": "0.8.4-main.fcfe5033a5",
90
+ "@dxos/test-utils": "0.8.4-main.fcfe5033a5",
91
+ "@dxos/ui-theme": "0.8.4-main.fcfe5033a5"
76
92
  },
77
93
  "peerDependencies": {
78
- "effect": "^3.13.3",
79
- "react": "~18.2.0",
80
- "react-dom": "~18.2.0",
81
- "@dxos/react-ui": "0.8.4-main.f9ba587",
82
- "@dxos/react-ui-theme": "0.8.4-main.f9ba587"
94
+ "effect": "3.20.0",
95
+ "react": "~19.2.3",
96
+ "react-dom": "~19.2.3",
97
+ "@dxos/react-ui": "0.8.4-main.fcfe5033a5",
98
+ "@dxos/ui-theme": "0.8.4-main.fcfe5033a5"
83
99
  },
84
100
  "publishConfig": {
85
101
  "access": "public"
@@ -2,57 +2,45 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { Capabilities, contributes, createIntent, defineModule, definePlugin, Events } from '@dxos/app-framework';
6
- import { ClientEvents } from '@dxos/plugin-client';
7
- import { SpaceCapabilities } from '@dxos/plugin-space';
8
- import { defineObjectForm } from '@dxos/plugin-space/types';
5
+ import * as Effect from 'effect/Effect';
6
+ import * as Option from 'effect/Option';
7
+
8
+ import { Plugin } from '@dxos/app-framework';
9
+ import { AppPlugin } from '@dxos/app-toolkit';
10
+ import { Annotation } from '@dxos/echo';
11
+ import { Operation } from '@dxos/operation';
12
+ import { SpaceOperation } from '@dxos/plugin-space/operations';
13
+ import { type CreateObject } from '@dxos/plugin-space/types';
9
14
  import { translations as boardTranslations } from '@dxos/react-ui-board';
10
15
 
11
- import { IntentResolver, ReactSurface } from './capabilities';
12
- import { meta } from './meta';
16
+ import { ReactSurface } from '#capabilities';
17
+ import { meta } from '#meta';
18
+ import { Board } from '#types';
19
+
13
20
  import { translations } from './translations';
14
- import { Board } from './types';
15
21
 
16
- export const BoardPlugin = () => {
17
- return definePlugin(meta, [
18
- defineModule({
19
- id: `${meta.id}/module/translations`,
20
- activatesOn: Events.SetupTranslations,
21
- activate: () => contributes(Capabilities.Translations, [...translations, ...boardTranslations]),
22
- }),
23
- defineModule({
24
- id: `${meta.id}/module/metadata`,
25
- activatesOn: Events.SetupMetadata,
26
- activate: () =>
27
- // TODO(burdon): "Metadata" here seems non-descriptive; is this specifically for the type? ObjectMetadata?
28
- contributes(Capabilities.Metadata, {
29
- id: Board.Board.typename,
30
- metadata: {
31
- icon: 'ph--squares-four--regular',
32
- },
33
- }),
34
- }),
35
- defineModule({
36
- id: `${meta.id}/module/object-form`,
37
- activatesOn: ClientEvents.SetupSchema,
38
- activate: () =>
39
- contributes(
40
- SpaceCapabilities.ObjectForm,
41
- defineObjectForm({
42
- objectSchema: Board.Board,
43
- getIntent: () => createIntent(Board.Create),
44
- }),
45
- ),
46
- }),
47
- defineModule({
48
- id: `${meta.id}/module/react-surface`,
49
- activatesOn: Events.SetupReactSurface,
50
- activate: ReactSurface,
51
- }),
52
- defineModule({
53
- id: `${meta.id}/module/intent-resolver`,
54
- activatesOn: Events.SetupIntentResolver,
55
- activate: IntentResolver,
56
- }),
57
- ]);
58
- };
22
+ export const BoardPlugin = Plugin.define(meta).pipe(
23
+ AppPlugin.addMetadataModule({
24
+ metadata: {
25
+ id: Board.Board.typename,
26
+ metadata: {
27
+ icon: Annotation.IconAnnotation.get(Board.Board).pipe(Option.getOrThrow).icon,
28
+ iconHue: Annotation.IconAnnotation.get(Board.Board).pipe(Option.getOrThrow).hue ?? 'white',
29
+ createObject: ((props, options) =>
30
+ Effect.gen(function* () {
31
+ const object = Board.makeBoard(props);
32
+ return yield* Operation.invoke(SpaceOperation.AddObject, {
33
+ object,
34
+ target: options.target,
35
+ hidden: true,
36
+ targetNodeId: options.targetNodeId,
37
+ });
38
+ })) satisfies CreateObject,
39
+ },
40
+ },
41
+ }),
42
+ AppPlugin.addSchemaModule({ schema: [Board.Board] }),
43
+ AppPlugin.addSurfaceModule({ activate: ReactSurface }),
44
+ AppPlugin.addTranslationsModule({ translations: [...translations, ...boardTranslations] }),
45
+ Plugin.make,
46
+ );
@@ -2,7 +2,6 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { lazy } from '@dxos/app-framework';
5
+ import { Capability } from '@dxos/app-framework';
6
6
 
7
- export const IntentResolver = lazy(() => import('./intent-resolver'));
8
- export const ReactSurface = lazy(() => import('./react-surface'));
7
+ export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));
@@ -2,21 +2,30 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
+ import * as Effect from 'effect/Effect';
5
6
  import React from 'react';
6
7
 
7
- import { contributes, Capabilities, type PluginContext, createSurface } from '@dxos/app-framework';
8
- import { Obj } from '@dxos/echo';
8
+ import { Capabilities, Capability } from '@dxos/app-framework';
9
+ import { Surface } from '@dxos/app-framework/ui';
10
+ import { AppSurface } from '@dxos/app-toolkit/ui';
9
11
 
10
- import { BoardContainer } from '../components';
11
- import { meta } from '../meta';
12
- import { Board } from '../types';
12
+ import { BoardContainer } from '#containers';
13
+ import { Board } from '#types';
13
14
 
14
- export default (context: PluginContext) =>
15
- contributes(Capabilities.ReactSurface, [
16
- createSurface({
17
- id: meta.id,
18
- role: ['article', 'section'],
19
- filter: (data): data is { subject: Board.Board } => Obj.instanceOf(Board.Board, data.subject),
20
- component: ({ data, role }) => <BoardContainer board={data.subject} role={role} />,
21
- }),
22
- ]);
15
+ export default Capability.makeModule(() =>
16
+ Effect.succeed(
17
+ Capability.contributes(Capabilities.ReactSurface, [
18
+ Surface.create({
19
+ id: 'root',
20
+ // TODO(wittjosiah): Split into multiple surfaces if this filter proves too strict for non-article roles.
21
+ filter: AppSurface.oneOf(
22
+ AppSurface.object(AppSurface.Article, Board.Board),
23
+ AppSurface.object(AppSurface.Section, Board.Board),
24
+ ),
25
+ component: ({ role, data }) => (
26
+ <BoardContainer role={role} subject={data.subject} attendableId={data.attendableId} />
27
+ ),
28
+ }),
29
+ ]),
30
+ ),
31
+ );
@@ -1,5 +1,3 @@
1
1
  //
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
-
5
- export * from './BoardContainer';
@@ -0,0 +1,122 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { type StoryObj } from '@storybook/react-vite';
6
+ import * as Effect from 'effect/Effect';
7
+ import React, { useEffect, useState } from 'react';
8
+
9
+ import { withPluginManager } from '@dxos/app-framework/testing';
10
+ import { Obj } from '@dxos/echo';
11
+ import { ClientPlugin } from '@dxos/plugin-client';
12
+ import { initializeIdentity } from '@dxos/plugin-client/testing';
13
+ import { PreviewPlugin } from '@dxos/plugin-preview';
14
+ import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
15
+ import { random } from '@dxos/random';
16
+ import { Filter, Ref, useQuery, useSpaces } from '@dxos/react-client/echo';
17
+ import { translations as stackTranslations } from '@dxos/react-ui-stack';
18
+ import { withLayout } from '@dxos/react-ui/testing';
19
+ import { Organization, Person } from '@dxos/types';
20
+
21
+ import { Board } from '#types';
22
+
23
+ import { translations } from '../../translations';
24
+ import { BoardContainer } from './BoardContainer';
25
+
26
+ random.seed(0);
27
+
28
+ const createBoard = () =>
29
+ Obj.make(Board.Board, {
30
+ name: 'Test Board',
31
+ items: [],
32
+ layout: {
33
+ size: { width: 7, height: 5 },
34
+ cells: {},
35
+ },
36
+ });
37
+
38
+ const createOrg = () =>
39
+ Obj.make(Organization.Organization, {
40
+ name: random.commerce.productName(),
41
+ description: random.lorem.paragraph(),
42
+ image: random.image.url(),
43
+ website: random.internet.url(),
44
+ // TODO(burdon): Fix.
45
+ // status: random.helpers.arrayElement(Organization.StatusOptions).id,
46
+ });
47
+
48
+ const DefaultStory = () => {
49
+ const spaces = useSpaces();
50
+ const space = spaces[spaces.length - 1];
51
+ const boards = useQuery(space?.db, Filter.type(Board.Board));
52
+ const [board, setBoard] = useState<Board.Board>();
53
+
54
+ useEffect(() => {
55
+ if (boards.length && !board) {
56
+ const board = boards[0];
57
+ setBoard(board);
58
+ }
59
+ }, [boards]);
60
+
61
+ if (!board) {
62
+ return null;
63
+ }
64
+
65
+ return <BoardContainer role='board' subject={board} attendableId='test' />;
66
+ };
67
+
68
+ //
69
+ // Story definitions
70
+ //
71
+
72
+ const meta = {
73
+ title: 'plugins/plugin-board/containers/BoardContainer',
74
+ render: DefaultStory,
75
+ decorators: [
76
+ withLayout({ layout: 'fullscreen' }),
77
+ withPluginManager({
78
+ plugins: [
79
+ ...corePlugins(),
80
+ ClientPlugin({
81
+ types: [Organization.Organization, Person.Person, Board.Board],
82
+ onClientInitialized: ({ client }) =>
83
+ Effect.gen(function* () {
84
+ yield* initializeIdentity(client);
85
+ const space = yield* Effect.promise(() => client.spaces.create());
86
+ yield* Effect.promise(() => space.waitUntilReady());
87
+ const board = space.db.add(createBoard());
88
+
89
+ Obj.change(board, (board) => {
90
+ // Add some sample items
91
+ Array.from({ length: 10 }).map(() => {
92
+ const org = createOrg();
93
+ space.db.add(org);
94
+ board.items.push(Ref.make(org));
95
+ board.layout.cells[org.id] = {
96
+ x: Math.floor(Math.random() * 5) - 2,
97
+ y: Math.floor(Math.random() * 5) - 2,
98
+ width: 1,
99
+ height: 1,
100
+ };
101
+ return org;
102
+ });
103
+ });
104
+ }),
105
+ }),
106
+
107
+ StorybookPlugin({}),
108
+ PreviewPlugin(),
109
+ ],
110
+ }),
111
+ ],
112
+ parameters: {
113
+ layout: 'fullscreen',
114
+ translations: [...translations, ...stackTranslations],
115
+ },
116
+ };
117
+
118
+ export default meta;
119
+
120
+ type Story = StoryObj<typeof meta>;
121
+
122
+ export const Default: Story = {};
@@ -0,0 +1,154 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import React, { useCallback, useMemo, useRef, useState } from 'react';
6
+
7
+ import { Surface } from '@dxos/app-framework/ui';
8
+ import { AppSurface } from '@dxos/app-toolkit/ui';
9
+ import { Filter, Obj, Ref } from '@dxos/echo';
10
+ import { useObject, useObjects } from '@dxos/echo-react';
11
+ import { invariant } from '@dxos/invariant';
12
+ import { useQuery } from '@dxos/react-client/echo';
13
+ import { Panel } from '@dxos/react-ui';
14
+ import { useAttention } from '@dxos/react-ui-attention';
15
+ import { Board, type BoardController, type BoardRootProps, type Position } from '@dxos/react-ui-board';
16
+ import { ObjectPicker, type ObjectPickerContentProps } from '@dxos/react-ui-form';
17
+ import { isNonNullable } from '@dxos/util';
18
+
19
+ import { type Board as BoardType } from '#types';
20
+
21
+ const DEFAULT_POSITION = { x: 0, y: 0 } satisfies Position;
22
+
23
+ type PickerState = {
24
+ position: Position;
25
+ };
26
+
27
+ export type BoardContainerProps = AppSurface.ObjectArticleProps<BoardType.Board>;
28
+
29
+ export const BoardContainer = ({ role, subject: board, attendableId }: BoardContainerProps) => {
30
+ const controller = useRef<BoardController>(null);
31
+ const [boardItems] = useObject(board, 'items');
32
+ const items = useObjects(boardItems ?? []);
33
+ const addTriggerRef = useRef<HTMLButtonElement | null>(null);
34
+ const [pickerState, setPickerState] = useState<PickerState | null>(null);
35
+ const { hasAttention } = useAttention(attendableId);
36
+
37
+ const db = Obj.getDatabase(board);
38
+ // TODO(burdon): Use search.
39
+ const objects = useQuery(db, Filter.everything());
40
+ const options = useMemo<ObjectPickerContentProps['options']>(
41
+ () =>
42
+ objects
43
+ .filter((obj) => obj.id !== board.id)
44
+ .map((obj) => {
45
+ const label = Obj.getLabel(obj);
46
+ if (label) {
47
+ return {
48
+ id: obj.id,
49
+ label,
50
+ hue: 'neutral' as const,
51
+ };
52
+ }
53
+ })
54
+ .filter(isNonNullable)
55
+ .sort(({ label: a }, { label: b }) => a.toLocaleLowerCase().localeCompare(b.toLocaleLowerCase())),
56
+ [objects],
57
+ );
58
+
59
+ const handleAdd = useCallback<NonNullable<BoardRootProps['onAdd']>>(
60
+ async (anchor, position = DEFAULT_POSITION) => {
61
+ const db = Obj.getDatabase(board);
62
+ invariant(db);
63
+ addTriggerRef.current = anchor;
64
+ setPickerState({
65
+ position,
66
+ });
67
+ },
68
+ [board],
69
+ );
70
+
71
+ // TODO(burdon): Use intents so can be undone.
72
+ const handleDelete = useCallback<NonNullable<BoardRootProps['onDelete']>>(
73
+ (id) => {
74
+ // TODO(burdon): Impl. DXN.equals and pass in DXN from `id`.
75
+ const idx = board.items.findIndex((ref) => ref.dxn.asEchoDXN()?.echoId === id);
76
+ Obj.change(board, (board) => {
77
+ if (idx !== -1) {
78
+ board.items.splice(idx, 1);
79
+ }
80
+ delete board.layout.cells[id];
81
+ });
82
+ },
83
+ [board],
84
+ );
85
+
86
+ const handleMove = useCallback<NonNullable<BoardRootProps['onMove']>>(
87
+ (id, position) => {
88
+ const layout = board.layout.cells[id];
89
+ Obj.change(board, (board) => {
90
+ board.layout.cells[id] = { ...layout, ...position };
91
+ });
92
+ },
93
+ [board],
94
+ );
95
+
96
+ const handleSelect = useCallback<NonNullable<ObjectPickerContentProps['onSelect']>>(
97
+ (id) => {
98
+ if (!pickerState) {
99
+ return;
100
+ }
101
+
102
+ // Find the selected object by id from the space.
103
+ const selectedObject = objects.find((obj) => obj.id === id);
104
+ if (!Obj.isObject(selectedObject)) {
105
+ return;
106
+ }
107
+
108
+ // Create a reference to the selected object and add it to the board.
109
+ Obj.change(board, (board) => {
110
+ board.items.push(Ref.make(selectedObject));
111
+
112
+ // Set the layout position for the new item.
113
+ board.layout.cells[selectedObject.id.toString()] = pickerState.position;
114
+ });
115
+
116
+ // Close the picker.
117
+ setPickerState(null);
118
+ },
119
+ [pickerState, objects, board],
120
+ );
121
+
122
+ return (
123
+ <Board.Root ref={controller} layout={board.layout} onAdd={handleAdd} onDelete={handleDelete} onMove={handleMove}>
124
+ <ObjectPicker.Root
125
+ open={!!pickerState}
126
+ onOpenChange={(nextOpen: boolean) => {
127
+ setPickerState(nextOpen ? { position: DEFAULT_POSITION } : null);
128
+ }}
129
+ >
130
+ <Panel.Root role={role}>
131
+ <Panel.Toolbar asChild>
132
+ <Board.Toolbar disabled={!hasAttention} />
133
+ </Panel.Toolbar>
134
+ <Panel.Content asChild>
135
+ <Board.Container>
136
+ <Board.Viewport classNames='border-none'>
137
+ <Board.Backdrop />
138
+ <Board.Content>
139
+ {items?.map((item, index) => (
140
+ <Board.Cell item={item} key={index} layout={board.layout?.cells[item.id] ?? { x: 0, y: 0 }}>
141
+ <Surface.Surface type={AppSurface.Card} data={{ subject: item }} limit={1} />
142
+ </Board.Cell>
143
+ ))}
144
+ </Board.Content>
145
+ </Board.Viewport>
146
+ </Board.Container>
147
+ </Panel.Content>
148
+ </Panel.Root>
149
+ <ObjectPicker.Content options={options} onSelect={handleSelect} classNames='dx-card-popover-width' />
150
+ <ObjectPicker.VirtualTrigger virtualRef={addTriggerRef} />
151
+ </ObjectPicker.Root>
152
+ </Board.Root>
153
+ );
154
+ };
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export { BoardContainer as default } from './BoardContainer';
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { type ComponentType, lazy } from 'react';
6
+
7
+ export const BoardContainer: ComponentType<any> = lazy(() => import('./BoardContainer'));
package/src/index.ts CHANGED
@@ -3,5 +3,6 @@
3
3
  //
4
4
 
5
5
  export * from './meta';
6
+ export * from './types';
6
7
 
7
8
  export * from './BoardPlugin';
package/src/meta.ts CHANGED
@@ -2,14 +2,18 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { type PluginMeta } from '@dxos/app-framework';
5
+ import { type Plugin } from '@dxos/app-framework';
6
+ import { trim } from '@dxos/util';
6
7
 
7
- export const meta: PluginMeta = {
8
- id: 'dxos.org/plugin/board',
8
+ export const meta: Plugin.Meta = {
9
+ id: 'org.dxos.plugin.board',
9
10
  name: 'Board',
10
- description:
11
- 'A spatial, infinite canvas app combining notes, media, and whiteboarding in a tactile, visual interface.',
11
+ description: trim`
12
+ Infinite canvas workspace that combines sticky notes, media, and whiteboarding tools.
13
+ Arrange and connect ideas freely in a visual space perfect for brainstorming and creative collaboration.
14
+ `,
12
15
  icon: 'ph--squares-four--regular',
16
+ iconHue: 'green',
13
17
  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-board',
14
18
  screenshots: [],
15
19
  };