@dxos/plugin-sheet 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/src/components/SheetToolbar/useToolbarState.ts

@@ -2,15 +2,32 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useMemo } from 'react';
-
-import { live } from '@dxos/live-object';
+import { Atom, type Registry, RegistryContext, useAtomValue } from '@effect-atom/atom-react';
+import { useContext, useMemo } from 'react';
 
 import { type AlignState } from './align';
 import { type StyleState } from './style';
 
 export type ToolbarState = Partial<StyleState & AlignState>;
+export type ToolbarStateAtom = Atom.Writable<ToolbarState>;
+
+/**
+ * Creates a reactive toolbar state Atom.
+ */
+export const useToolbarState = (initialState: ToolbarState = {}): ToolbarStateAtom => {
+  return useMemo(() => Atom.make<ToolbarState>(initialState).pipe(Atom.keepAlive), []);
+};
+
+/**
+ * Hook to read the current toolbar state value.
+ */
+export const useToolbarStateValue = (stateAtom: ToolbarStateAtom): ToolbarState => {
+  return useAtomValue(stateAtom);
+};
 
-export const useToolbarState = (initialState: ToolbarState = {}) => {
-  return useMemo(() => live<ToolbarState>(initialState), []);
+/**
+ * Hook to get the registry for updating toolbar state.
+ */
+export const useToolbarStateRegistry = (): Registry.Registry => {
+  return useContext(RegistryContext);
 };

package/src/components/index.ts

@@ -2,11 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
-import { lazy } from 'react';
-
 export * from './ComputeGraph';
-export * from './GridSheet';
-export * from './RangeList';
-export * from './SheetContext';
-
-export const SheetContainer = lazy(() => import('./SheetContainer'));
+export * from './Sheet';

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

@@ -2,42 +2,47 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 import React, { useCallback } from 'react';
 
 import { rangeToA1Notation } from '@dxos/compute';
-import { Callout, useTranslation } from '@dxos/react-ui';
+import { Obj } from '@dxos/echo';
+import { Input, Message, useTranslation } from '@dxos/react-ui';
 import { List } from '@dxos/react-ui-list';
-import { ghostHover } from '@dxos/react-ui-theme';
+import { ghostHover } from '@dxos/ui-theme';
 
-import { SHEET_PLUGIN } from '../../meta';
+import { meta } from '../../meta';
 import { rangeFromIndex } from '../../types';
-import { Range, type SheetType } from '../../types';
+import { Sheet } from '../../types';
 
 export type RangeListProps = {
-  sheet: SheetType;
+  sheet: Sheet.Sheet;
 };
 
 export const RangeList = ({ sheet }: RangeListProps) => {
-  const { t } = useTranslation(SHEET_PLUGIN);
+  const { t } = useTranslation(meta.id);
   // TODO(thure): Implement similar to comments, #8121
-  const handleSelectRange = (range: Range) => {};
+  const handleSelectRange = (range: Sheet.Range) => {};
   const handleDeleteRange = useCallback(
-    (range: Range) => {
+    (range: Sheet.Range) => {
       const index = sheet.ranges.findIndex((sheetRange) => sheetRange === range);
-      sheet.ranges.splice(index, 1);
+      Obj.change(sheet, (obj) => {
+        obj.ranges.splice(index, 1);
+      });
     },
     [sheet],
   );
   return (
     <>
-      <h2 className='mbs-cardSpacingBlock mbe-labelSpacingBlock text-sm font-semibold'>{t('range list heading')}</h2>
+      <Input.Root>
+        <Input.Label>{t('range list heading')}</Input.Label>
+      </Input.Root>
       {sheet.ranges.length < 1 ? (
-        <Callout.Root>
-          <Callout.Title>{t('no ranges message')}</Callout.Title>
-        </Callout.Root>
+        <Message.Root>
+          <Message.Title>{t('no ranges message')}</Message.Title>
+        </Message.Root>
       ) : (
-        <List.Root<Range> items={sheet.ranges} isItem={Schema.is(Range)}>
+        <List.Root<Sheet.Range> items={sheet.ranges} isItem={Schema.is(Sheet.Range)}>
           {({ items: ranges }) =>
             ranges.map((range, i) => (
               <List.Item key={i} item={range} classNames={['p-2', ghostHover]}>

package/src/containers/RangeList/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { RangeList } from './RangeList';
+
+export default RangeList;

package/src/containers/SheetContainer/SheetContainer.stories.tsx

@@ -0,0 +1,94 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Meta } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React, { useContext } from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Obj } from '@dxos/echo';
+import { OperationResolver } from '@dxos/operation';
+import { corePlugins } from '@dxos/plugin-testing';
+import { useSpace } from '@dxos/react-client/echo';
+import { withClientProvider } from '@dxos/react-client/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { AttendableContainer } from '@dxos/react-ui-attention';
+
+import { ComputeGraphContext, useComputeGraph } from '../../components';
+import { createTestCells, useTestSheet, withComputeGraphDecorator } from '../../testing';
+import { translations } from '../../translations';
+import { Sheet, SheetOperation } from '../../types';
+import RangeList from '../RangeList';
+
+import { SheetContainer } from './SheetContainer';
+
+const meta = {
+  title: 'plugins/plugin-sheet/containers/SheetContainer',
+  component: SheetContainer,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'fullscreen' }),
+    withClientProvider({ types: [Sheet.Sheet], createSpace: true }),
+    withComputeGraphDecorator(),
+    withPluginManager({
+      plugins: [...corePlugins()],
+      capabilities: [
+        Capability.contributes(Capabilities.OperationResolver, [
+          OperationResolver.make({
+            operation: SheetOperation.DropAxis,
+            handler: ({ model, axis, axisIndex }) =>
+              Effect.sync(() => {
+                model[axis === 'col' ? 'dropColumn' : 'dropRow'](axisIndex);
+                return { axis, axisIndex, index: 0, axisMeta: null, values: [] };
+              }),
+          }),
+        ]),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof SheetContainer>;
+
+export default meta;
+
+export const Default = () => {
+  const space = useSpace();
+  const graph = useComputeGraph(space);
+  const { registry } = useContext(ComputeGraphContext) ?? {};
+  const sheet = useTestSheet(space, graph, { cells: createTestCells() });
+  if (!sheet || !space || !registry) {
+    return null;
+  }
+
+  return (
+    <AttendableContainer id={Obj.getDXN(sheet).toString()} classNames='contents'>
+      <SheetContainer role='article' space={space} subject={sheet} registry={registry} ignoreAttention />
+    </AttendableContainer>
+  );
+};
+
+export const Spec = () => {
+  const space = useSpace();
+  const graph = useComputeGraph(space);
+  const { registry } = useContext(ComputeGraphContext) ?? {};
+  const sheet = useTestSheet(space, graph, { cells: { A1: { value: 'Ready' } } });
+  if (!sheet || !space || !registry) {
+    return null;
+  }
+
+  return (
+    <AttendableContainer id={Obj.getDXN(sheet).toString()} classNames='contents'>
+      <div role='none' className='w-full grid grid-cols-[1fr_20rem]'>
+        <SheetContainer role='article' space={space} subject={sheet} registry={registry} ignoreAttention />
+        <div role='none' data-testid='grid.range-list'>
+          <RangeList sheet={sheet} />
+        </div>
+      </div>
+    </AttendableContainer>
+  );
+};

package/src/containers/SheetContainer/SheetContainer.tsx

@@ -0,0 +1,57 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { type ComputeGraphRegistry } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { type Space } from '@dxos/react-client/echo';
+import { Panel } from '@dxos/react-ui';
+
+import { ComputeGraphContextProvider, Sheet, useComputeGraph } from '../../components';
+import { type Sheet as SheetType } from '../../types';
+
+export type SheetContainerProps = SurfaceComponentProps<
+  SheetType.Sheet,
+  {
+    space: Space;
+    registry: ComputeGraphRegistry;
+    ignoreAttention?: boolean;
+  }
+>;
+
+export const SheetContainer = ({ registry, ...props }: SheetContainerProps) => (
+  <ComputeGraphContextProvider registry={registry}>
+    <SheetContainerInner {...props} />
+  </ComputeGraphContextProvider>
+);
+
+const SheetContainerInner = ({
+  role,
+  subject: sheet,
+  space,
+  ignoreAttention,
+}: Omit<SheetContainerProps, 'registry'>) => {
+  const graph = useComputeGraph(space);
+  if (!graph) {
+    return null;
+  }
+
+  return (
+    <Sheet.Root graph={graph} sheet={sheet} ignoreAttention={ignoreAttention}>
+      <Panel.Root classNames={role === 'section' && 'aspect-aquare'}>
+        <Panel.Toolbar asChild>
+          <Sheet.Toolbar id={Obj.getDXN(sheet).toString()} />
+        </Panel.Toolbar>
+        <Panel.Content asChild>
+          <Sheet.Content />
+        </Panel.Content>
+        <Panel.Statusbar asChild>
+          <Sheet.Statusbar />
+        </Panel.Statusbar>
+      </Panel.Root>
+    </Sheet.Root>
+  );
+};

package/src/{components → containers}/SheetContainer/index.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2024 DXOS.org
+// Copyright 2023 DXOS.org
 //
 
 import { SheetContainer } from './SheetContainer';

package/src/containers/index.ts

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

package/src/extensions/compute.stories.tsx

@@ -2,31 +2,32 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useEffect, useMemo } from 'react';
 
+import { OperationPlugin, RuntimePlugin } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
 import { PublicKey } from '@dxos/keys';
 import { useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { useThemeContext } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { useTextEditor } from '@dxos/react-ui-editor';
 import {
   createBasicExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   decorateMarkdown,
   documentId,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
-import { withTheme, withLayout } from '@dxos/storybook-utils';
+} from '@dxos/ui-editor';
 import { isNonNullable } from '@dxos/util';
 
-import { compute, computeGraphFacet } from './compute';
-import { GridSheet, SheetProvider, useComputeGraph } from '../components';
+import { Sheet, useComputeGraph } from '../components';
 import { useSheetModel } from '../model';
 import { useTestSheet, withComputeGraphDecorator } from '../testing';
-import { SheetType } from '../types';
+import { Sheet as SheetType } from '../types';
+
+import { compute, computeGraphFacet } from './compute';
 
 const str = (...lines: string[]) => lines.join('\n');
 
@@ -41,7 +42,7 @@ type EditorProps = {
 
 const SHEET_NAME = 'Test Sheet';
 
-const EditorStory = ({ text }: EditorProps) => {
+const DefaultStory = ({ text }: EditorProps) => {
   const id = useMemo(() => PublicKey.random(), []);
   const { themeMode } = useThemeContext();
   const space = useSpace();
@@ -51,7 +52,7 @@ const EditorStory = ({ text }: EditorProps) => {
       initialValue: text,
       extensions: [
         createBasicExtensions(),
-        createMarkdownExtensions({ themeMode }),
+        createMarkdownExtensions(),
         createThemeExtensions({ themeMode, syntaxHighlighting: true }),
         documentId.of(id.toHex()),
         computeGraph && computeGraphFacet.of(computeGraph),
@@ -72,7 +73,12 @@ const Grid = () => {
   const model = useSheetModel(graph, sheet);
   useEffect(() => {
     if (model) {
-      model.setValues({ A1: { value: 100 }, A2: { value: 200 }, A3: { value: 300 }, A5: { value: '=SUM(A1:A3)' } });
+      model.setValues({
+        A1: { value: 100 },
+        A2: { value: 200 },
+        A3: { value: 300 },
+        A5: { value: '=SUM(A1:A3)' },
+      });
     }
   }, [model]);
 
@@ -82,9 +88,9 @@ const Grid = () => {
 
   return (
     <div className='flex w-[40rem] overflow-hidden'>
-      <SheetProvider graph={graph} sheet={sheet}>
-        <GridSheet />
-      </SheetProvider>
+      <Sheet.Root graph={graph} sheet={sheet}>
+        <Sheet.Content />
+      </Sheet.Root>
     </div>
   );
 };
@@ -92,15 +98,36 @@ const Grid = () => {
 const GraphStory = (props: EditorProps) => {
   return (
     <div className='grid grid-rows-2'>
-      <EditorStory {...props} />
+      <DefaultStory {...props} />
       <Grid />
     </div>
   );
 };
 
+const meta = {
+  title: 'plugins/plugin-sheet/extensions/compute',
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'fullscreen' }),
+    withClientProvider({
+      types: [SheetType.Sheet],
+      createIdentity: true,
+      createSpace: true,
+    }),
+    // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
+    withPluginManager({ plugins: [OperationPlugin(), RuntimePlugin()] }),
+    withComputeGraphDecorator(),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta;
+
+export default meta;
+
 // TODO(burdon): Inline formulae.
-export const Default = {
-  render: EditorStory,
+export const Default: StoryObj<typeof DefaultStory> = {
+  render: DefaultStory,
   args: {
     text: str(
       //
@@ -123,7 +150,7 @@ export const Default = {
   },
 };
 
-export const Graph = {
+export const Graph: StoryObj<typeof GraphStory> = {
   render: GraphStory,
   args: {
     text: str(
@@ -140,16 +167,3 @@ export const Graph = {
     ),
   },
 };
-
-const meta: Meta = {
-  title: 'plugins/plugin-sheet/extensions',
-  decorators: [
-    withClientProvider({ types: [SheetType], createIdentity: true, createSpace: true }),
-    withComputeGraphDecorator(),
-    withTheme,
-    withLayout({ fullscreen: true, classNames: 'justify-center' }),
-  ],
-  parameters: { layout: 'fullscreen' },
-};
-
-export default meta;

package/src/extensions/compute.ts

@@ -16,14 +16,14 @@ import { Decoration, EditorView, ViewPlugin, WidgetType } from '@codemirror/view
 
 import { type CleanupFn, debounce } from '@dxos/async';
 import {
-  createSheetName,
   type CellAddress,
   type CellScalarValue,
   type ComputeGraph,
   type ComputeNode,
+  createSheetName,
 } from '@dxos/compute';
 import { invariant } from '@dxos/invariant';
-import { documentId, singleValueFacet } from '@dxos/react-ui-editor';
+import { documentId, singleValueFacet } from '@dxos/ui-editor';
 
 const LANGUAGE_TAG = 'dx';
 
@@ -34,7 +34,7 @@ export const computeGraphFacet = singleValueFacet<ComputeGraph>();
 
 export type ComputeOptions = {};
 
-export const compute = (options: ComputeOptions = {}): Extension => {
+export const compute = (_options: ComputeOptions = {}): Extension => {
   let computeNode: ComputeNode | undefined;
 
   const update = (state: EditorState, current?: RangeSet<Decoration>) => {
@@ -53,7 +53,6 @@ export const compute = (options: ComputeOptions = {}): Extension => {
                   const text = node.node.getChild('CodeText');
                   if (type === LANGUAGE_TAG && text) {
                     const formula = state.sliceDoc(text.from, text.to);
-
                     const iter = current?.iter(node.node.from);
                     if (iter?.value && iter?.value.spec.formula === formula) {
                       // Add existing widget.

package/src/extensions/editor/index.ts

@@ -2,4 +2,4 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './extension';
+export * from './sheet-extension';

package/src/extensions/editor/{extension.test.ts → sheet-extension.test.ts}

@@ -10,7 +10,7 @@ import { describe, expect, test } from 'vitest';
 
 import { defaultFunctions } from '@dxos/compute';
 
-import { sheetExtension } from './extension';
+import { sheetExtension } from './sheet-extension';
 
 describe('formula parser', () => {
   const {

package/src/extensions/editor/{extension.ts → sheet-extension.ts}

@@ -20,8 +20,8 @@ import { spreadsheet } from 'codemirror-lang-spreadsheet';
 
 import { type FunctionDefinition } from '@dxos/compute';
 import { RANGE_NOTATION } from '@dxos/compute';
-import { singleValueFacet } from '@dxos/react-ui-editor';
-import { mx } from '@dxos/react-ui-theme';
+import { singleValueFacet } from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
 
 /**
  * https://codemirror.net/examples/styling
@@ -33,30 +33,30 @@ const highlightStyles = HighlightStyle.define([
   // Function.
   {
     tag: tags.name,
-    class: 'text-accentText',
+    class: 'text-accent-text',
   },
   // Range.
   {
     tag: tags.tagName,
-    class: 'text-pinkText',
+    class: 'text-pink-text',
   },
   // Values.
   {
     tag: tags.number,
-    class: 'text-tealText',
+    class: 'text-teal-text',
   },
   {
     tag: tags.bool,
-    class: 'text-tealText',
+    class: 'text-teal-text',
   },
   {
     tag: tags.string,
-    class: 'text-tealText',
+    class: 'text-teal-text',
   },
   // Error.
   {
     tag: tags.invalid,
-    class: 'text-unAccent',
+    class: 'text-un-accent',
   },
 ]);
 
@@ -75,7 +75,10 @@ export type SheetExtensionOptions = {
  * https://hyperformula.handsontable.com/guide/key-concepts.html#grammar
  */
 export const sheetExtension = ({ debug, functions = [] }: SheetExtensionOptions): Extension => {
-  const { extension, language } = spreadsheet({ idiom: 'en-US', decimalSeparator: '.' });
+  const { extension, language } = spreadsheet({
+    idiom: 'en-US',
+    decimalSeparator: '.',
+  });
 
   const createCompletion = (name: string) => {
     const { section = 'Custom', description, syntax } = functions.find((value) => value.name === name) ?? {};
@@ -94,7 +97,7 @@ export const sheetExtension = ({ debug, functions = [] }: SheetExtensionOptions)
 
         const title = document.createElement('h2');
         title.innerText = name;
-        title.className = 'text-lg font-mono text-accentText';
+        title.className = 'text-lg font-mono text-accent-text';
         root.appendChild(title);
 
         if (description) {
@@ -107,7 +110,7 @@ export const sheetExtension = ({ debug, functions = [] }: SheetExtensionOptions)
         if (syntax) {
           const detail = document.createElement('pre');
           detail.innerText = syntax;
-          detail.className = 'whitespace-pre-wrap text-greenText';
+          detail.className = 'whitespace-pre-wrap text-green-text';
           root.appendChild(detail);
         }
 
@@ -166,8 +169,8 @@ export const sheetExtension = ({ debug, functions = [] }: SheetExtensionOptions)
       icons: false,
       tooltipClass: () =>
         mx(
-          '!-left-[1px] !top-[33px] !-m-0 border !border-t-0 [&>ul]:!min-w-[198px]',
-          '[&>ul>li[aria-selected]]:!bg-accentSurface',
+          '!-left-[1px] !top-[33px] !-m-0 border border-h-0! [&>ul]:!min-w-[198px]',
+          '[&>ul>li[aria-selected]]:!bg-accent-surface',
           'border-separator',
         ),
     }),

package/src/index.ts

@@ -2,6 +2,6 @@
 // Copyright 2023 DXOS.org
 //
 
-export { SheetCapabilities } from './capabilities';
+export { SheetCapabilities } from './types';
 export * from './meta';
 export * from './SheetPlugin';