@dxos/react-ui-attention 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

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 (58) hide show
  1. package/dist/lib/browser/chunk-4SEURHOL.mjs +721 -0
  2. package/dist/lib/browser/chunk-4SEURHOL.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-GMKHOVJ5.mjs +1 -0
  4. package/dist/lib/browser/chunk-GMKHOVJ5.mjs.map +7 -0
  5. package/dist/lib/browser/index.mjs +85 -13
  6. package/dist/lib/browser/index.mjs.map +4 -4
  7. package/dist/lib/browser/meta.json +1 -1
  8. package/dist/lib/browser/testing/index.mjs +20 -5
  9. package/dist/lib/browser/testing/index.mjs.map +3 -3
  10. package/dist/lib/browser/types.mjs +2 -0
  11. package/dist/lib/browser/types.mjs.map +7 -0
  12. package/dist/lib/node-esm/chunk-6PQ4P7AL.mjs +723 -0
  13. package/dist/lib/node-esm/chunk-6PQ4P7AL.mjs.map +7 -0
  14. package/dist/lib/node-esm/chunk-UHVMYYIB.mjs +2 -0
  15. package/dist/lib/node-esm/chunk-UHVMYYIB.mjs.map +7 -0
  16. package/dist/lib/node-esm/index.mjs +85 -13
  17. package/dist/lib/node-esm/index.mjs.map +4 -4
  18. package/dist/lib/node-esm/meta.json +1 -1
  19. package/dist/lib/node-esm/testing/index.mjs +20 -5
  20. package/dist/lib/node-esm/testing/index.mjs.map +3 -3
  21. package/dist/lib/node-esm/types.mjs +3 -0
  22. package/dist/lib/node-esm/types.mjs.map +7 -0
  23. package/dist/types/src/attention.d.ts +56 -20
  24. package/dist/types/src/attention.d.ts.map +1 -1
  25. package/dist/types/src/components/AttentionGlyph.d.ts.map +1 -1
  26. package/dist/types/src/components/AttentionGlyph.stories.d.ts +9 -20
  27. package/dist/types/src/components/AttentionGlyph.stories.d.ts.map +1 -1
  28. package/dist/types/src/components/AttentionProvider.d.ts +15 -16
  29. package/dist/types/src/components/AttentionProvider.d.ts.map +1 -1
  30. package/dist/types/src/components/AttentionProvider.stories.d.ts +6 -4
  31. package/dist/types/src/components/AttentionProvider.stories.d.ts.map +1 -1
  32. package/dist/types/src/components/SelectionProvider.d.ts +6 -5
  33. package/dist/types/src/components/SelectionProvider.d.ts.map +1 -1
  34. package/dist/types/src/index.d.ts +1 -0
  35. package/dist/types/src/index.d.ts.map +1 -1
  36. package/dist/types/src/selection.d.ts +24 -4
  37. package/dist/types/src/selection.d.ts.map +1 -1
  38. package/dist/types/src/testing/decorators/withAttention.d.ts +5 -1
  39. package/dist/types/src/testing/decorators/withAttention.d.ts.map +1 -1
  40. package/dist/types/src/types.d.ts +9 -0
  41. package/dist/types/src/types.d.ts.map +1 -0
  42. package/dist/types/tsconfig.tsbuildinfo +1 -1
  43. package/package.json +38 -24
  44. package/src/attention.test.ts +188 -27
  45. package/src/attention.ts +175 -74
  46. package/src/components/AttentionGlyph.stories.tsx +17 -14
  47. package/src/components/AttentionGlyph.tsx +14 -7
  48. package/src/components/AttentionProvider.stories.tsx +13 -9
  49. package/src/components/AttentionProvider.tsx +80 -97
  50. package/src/components/SelectionProvider.tsx +66 -19
  51. package/src/index.ts +1 -0
  52. package/src/selection.ts +113 -72
  53. package/src/testing/decorators/withAttention.ts +21 -4
  54. package/src/types.ts +13 -0
  55. package/dist/lib/browser/chunk-3K54PTHR.mjs +0 -650
  56. package/dist/lib/browser/chunk-3K54PTHR.mjs.map +0 -7
  57. package/dist/lib/node-esm/chunk-LVRGGYEI.mjs +0 -652
  58. package/dist/lib/node-esm/chunk-LVRGGYEI.mjs.map +0 -7
package/src/selection.ts CHANGED
@@ -2,11 +2,11 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { untracked } from '@preact/signals-core';
6
- import { Match, Schema } from 'effect';
5
+ import { Atom, type Registry } from '@effect-atom/atom-react';
6
+ import * as Match from 'effect/Match';
7
+ import * as Schema from 'effect/Schema';
7
8
 
8
9
  import { invariant } from '@dxos/invariant';
9
- import { live, type Live } from '@dxos/live-object';
10
10
 
11
11
  // TODO(burdon): Reconcile with @dxos/graph.
12
12
 
@@ -69,117 +69,158 @@ export const getSelectionSet = (selectionManager: SelectionManager, contextId?:
69
69
  * Each context maintains its own selection mode and state.
70
70
  */
71
71
  export class SelectionManager {
72
- private readonly _state = live<{ selections: Record<string, Selection> }>({ selections: {} });
72
+ private readonly _state: Atom.Writable<{ selections: Record<string, Selection> }>;
73
+
74
+ constructor(
75
+ private readonly _registry: Registry.Registry,
76
+ initial: Record<string, Selection> = {},
77
+ ) {
78
+ this._state = Atom.make<{ selections: Record<string, Selection> }>({
79
+ selections: { ...initial },
80
+ });
81
+ }
73
82
 
74
- constructor(initial: Record<string, Selection> = {}) {
75
- if (Object.keys(initial).length > 0) {
76
- untracked(() => {
77
- this._state.selections = initial;
78
- });
79
- }
83
+ /**
84
+ * Get the state atom for reactive access in the graph system.
85
+ */
86
+ get state(): Atom.Atom<{ selections: Record<string, Selection> }> {
87
+ return this._state;
88
+ }
89
+
90
+ /**
91
+ * Gets the current state.
92
+ */
93
+ getState(): { selections: Record<string, Selection> } {
94
+ return this._registry.get(this._state);
95
+ }
96
+
97
+ /**
98
+ * Subscribe to changes in the selection state.
99
+ */
100
+ subscribe(cb: (state: { selections: Record<string, Selection> }) => void): () => void {
101
+ this._registry.get(this._state);
102
+ return this._registry.subscribe(this._state, () => {
103
+ cb(this._registry.get(this._state));
104
+ });
80
105
  }
81
106
 
82
107
  getSelectionContexts(): string[] {
83
- return Object.keys(this._state.selections);
108
+ return Object.keys(this._registry.get(this._state).selections);
84
109
  }
85
110
 
111
+ getSelection(contextId: string): Selection | undefined;
112
+ getSelection<T extends SelectionMode>(contextId: string, mode: T): Selection;
86
113
  getSelection<T extends SelectionMode | undefined>(
87
114
  contextId: string,
88
115
  mode: T = undefined as T,
89
- ): T extends undefined ? Live<Selection> | undefined : Live<Selection> {
90
- const selection = untracked(() => this._state.selections[contextId]);
116
+ ): Selection | undefined {
117
+ const state = this._registry.get(this._state);
118
+ const selection = state.selections[contextId];
91
119
  if (!mode || selection) {
92
120
  return selection;
93
121
  }
94
122
 
95
- return untracked(() => {
96
- this._state.selections[contextId] = defaultSelection(mode);
97
- return this._state.selections[contextId];
98
- });
123
+ // Create new selection for the context.
124
+ const newSelection = defaultSelection(mode);
125
+ this._registry.update(this._state, (state) => ({
126
+ selections: { ...state.selections, [contextId]: newSelection },
127
+ }));
128
+ return newSelection;
99
129
  }
100
130
 
101
131
  // TODO(burdon): Disambiguate with getSelection?
102
132
  getSelected<T extends SelectionMode>(contextId: string, mode: T = 'multi' as T): SelectionResult<T> {
103
133
  const selection = this.getSelection(contextId, mode);
104
134
  invariant(selection?.mode === mode, 'Selection mode mismatch');
135
+ // Cast required because TypeScript can't infer the relationship between T and the matched result.
105
136
  return Match.type<Selection>().pipe(
106
137
  Match.when({ mode: 'single' }, (s) => s.id),
107
138
  Match.when({ mode: 'multi' }, (s) => s.ids),
108
139
  Match.when({ mode: 'range' }, (s) => (s.from && s.to ? { from: s.from, to: s.to } : undefined)),
109
140
  Match.when({ mode: 'multi-range' }, (s) => s.ranges),
110
141
  Match.exhaustive,
111
- )(selection) as any;
142
+ )(selection) as SelectionResult<T>;
112
143
  }
113
144
 
114
145
  updateSingle(contextId: string, id: string): void {
115
- untracked(() => {
116
- const selection = this.getSelection(contextId, 'single');
117
- invariant(selection?.mode === 'single', 'Selection mode is not single');
118
- selection.id = id;
119
- });
146
+ const selection = this.getSelection(contextId, 'single');
147
+ invariant(selection?.mode === 'single', 'Selection mode is not single');
148
+ this._registry.update(this._state, (state) => ({
149
+ selections: {
150
+ ...state.selections,
151
+ [contextId]: { ...selection, id },
152
+ },
153
+ }));
120
154
  }
121
155
 
122
156
  updateMulti(contextId: string, ids: string[]) {
123
- untracked(() => {
124
- const selection = this.getSelection(contextId, 'multi');
125
- invariant(selection?.mode === 'multi', 'Selection mode is not multi');
126
- selection.ids.splice(0, selection.ids.length, ...ids);
127
- });
157
+ const selection = this.getSelection(contextId, 'multi');
158
+ invariant(selection?.mode === 'multi', 'Selection mode is not multi');
159
+ this._registry.update(this._state, (state) => ({
160
+ selections: {
161
+ ...state.selections,
162
+ [contextId]: { ...selection, ids: [...ids] },
163
+ },
164
+ }));
128
165
  }
129
166
 
130
167
  updateRange(contextId: string, from: string, to: string) {
131
- untracked(() => {
132
- const selection = this.getSelection(contextId, 'range');
133
- invariant(selection?.mode === 'range', 'Selection mode is not range');
134
- selection.from = from;
135
- selection.to = to;
136
- });
168
+ const selection = this.getSelection(contextId, 'range');
169
+ invariant(selection?.mode === 'range', 'Selection mode is not range');
170
+ this._registry.update(this._state, (state) => ({
171
+ selections: {
172
+ ...state.selections,
173
+ [contextId]: { ...selection, from, to },
174
+ },
175
+ }));
137
176
  }
138
177
 
139
178
  updateMultiRange(contextId: string, ranges: { from: string; to: string }[]) {
140
- untracked(() => {
141
- const selection = this.getSelection(contextId, 'multi-range');
142
- invariant(selection?.mode === 'multi-range', 'Selection mode is not multi-range');
143
- selection.ranges.splice(0, selection.ranges.length, ...ranges);
144
- });
179
+ const selection = this.getSelection(contextId, 'multi-range');
180
+ invariant(selection?.mode === 'multi-range', 'Selection mode is not multi-range');
181
+ this._registry.update(this._state, (state) => ({
182
+ selections: {
183
+ ...state.selections,
184
+ [contextId]: { ...selection, ranges: [...ranges] },
185
+ },
186
+ }));
145
187
  }
146
188
 
147
189
  clearSelection(contextId: string): void {
148
- untracked(() => {
149
- const selection = this.getSelection(contextId);
150
- Match.type<Selection | undefined>().pipe(
151
- Match.when(undefined, () => {
152
- // No-op.
153
- }),
154
- Match.when({ mode: 'single' }, (s) => {
155
- s.id = undefined;
156
- }),
157
- Match.when({ mode: 'multi' }, (s) => {
158
- s.ids.splice(0, s.ids.length);
159
- }),
160
- Match.when({ mode: 'range' }, (s) => {
161
- s.from = undefined;
162
- s.to = undefined;
163
- }),
164
- Match.when({ mode: 'multi-range' }, (s) => {
165
- s.ranges.splice(0, s.ranges.length);
166
- }),
167
- Match.exhaustive,
168
- )(selection);
169
- });
190
+ const selection = this.getSelection(contextId);
191
+ if (!selection) {
192
+ return;
193
+ }
194
+
195
+ const clearedSelection = Match.type<Selection>().pipe(
196
+ Match.when({ mode: 'single' }, (s) => ({ ...s, id: undefined })),
197
+ Match.when({ mode: 'multi' }, (s) => ({ ...s, ids: [] })),
198
+ Match.when({ mode: 'range' }, (s) => ({ ...s, from: undefined, to: undefined })),
199
+ Match.when({ mode: 'multi-range' }, (s) => ({ ...s, ranges: [] })),
200
+ Match.exhaustive,
201
+ )(selection);
202
+
203
+ this._registry.update(this._state, (state) => ({
204
+ selections: {
205
+ ...state.selections,
206
+ [contextId]: clearedSelection,
207
+ },
208
+ }));
170
209
  }
171
210
 
172
211
  toggleSelection(contextId: string, id: string): void {
173
- untracked(() => {
174
- const selection = this.getSelection(contextId, 'multi');
175
- invariant(selection?.mode === 'multi', 'Selection mode is not multi');
176
-
177
- if (selection.ids.includes(id)) {
178
- const index = selection.ids.indexOf(id);
179
- selection.ids.splice(index, 1);
180
- } else {
181
- selection.ids.push(id);
182
- }
183
- });
212
+ const selection = this.getSelection(contextId, 'multi');
213
+ invariant(selection?.mode === 'multi', 'Selection mode is not multi');
214
+
215
+ const newIds = selection.ids.includes(id)
216
+ ? selection.ids.filter((existingId) => existingId !== id)
217
+ : [...selection.ids, id];
218
+
219
+ this._registry.update(this._state, (state) => ({
220
+ selections: {
221
+ ...state.selections,
222
+ [contextId]: { ...selection, ids: newIds },
223
+ },
224
+ }));
184
225
  }
185
226
  }
@@ -2,11 +2,28 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
+ import { Registry, RegistryContext } from '@effect-atom/atom-react';
5
6
  import { type Decorator } from '@storybook/react';
6
- import { createElement } from 'react';
7
+ import { createElement, useMemo } from 'react';
7
8
 
8
- import { RootAttentionProvider } from '../../components';
9
+ import { AttentionManager } from '../../attention';
10
+ import { RootAttentionProvider, SelectionProvider } from '../../components';
9
11
 
10
- export const withAttention: Decorator = (Story) => {
11
- return createElement(RootAttentionProvider, {}, createElement(Story));
12
+ /**
13
+ * Storybook decorator that provides attention context.
14
+ * @param initialAttendedId Optional ID to set as initially attended.
15
+ */
16
+ export const withAttention = (initialAttendedId?: string): Decorator => {
17
+ return (Story) => {
18
+ const registry = useMemo(() => Registry.make(), []);
19
+ const attention = useMemo(
20
+ () => (initialAttendedId ? new AttentionManager(registry, [initialAttendedId]) : undefined),
21
+ [registry],
22
+ );
23
+ return createElement(
24
+ RegistryContext.Provider,
25
+ { value: registry },
26
+ createElement(RootAttentionProvider, { attention }, createElement(SelectionProvider, {}, createElement(Story))),
27
+ );
28
+ };
12
29
  };
package/src/types.ts ADDED
@@ -0,0 +1,13 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export type Attention = {
6
+ hasAttention: boolean;
7
+ isAncestor: boolean;
8
+ isRelated: boolean;
9
+ };
10
+
11
+ export type CurrentState = {
12
+ current: string[];
13
+ };