@dxos/plugin-sheet 0.8.4-main.67995b8 → 0.8.4-main.ae835ea

package/src/components/GridSheet/GridSheet.stories.tsx

@@ -2,24 +2,24 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
 import { IntentPlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
+import { testFunctionPlugins } from '@dxos/compute/testing';
 import { useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
-import { withTheme, withLayout } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
-import { GridSheet } from './GridSheet';
 import { createTestCells, useTestSheet, withComputeGraphDecorator } from '../../testing';
 import { translations } from '../../translations';
-import { SheetType } from '../../types';
+import { Sheet } from '../../types';
 import { useComputeGraph } from '../ComputeGraph';
 import { SheetProvider } from '../SheetContext';
 
+import { GridSheet } from './GridSheet';
+
 export const Basic = () => {
   const space = useSpace();
   const graph = useComputeGraph(space);
@@ -30,24 +30,30 @@ export const Basic = () => {
 
   return (
     <SheetProvider graph={graph} sheet={sheet} ignoreAttention>
-      <GridSheet />
+      <div role='none' className='grid bs-full is-full'>
+        <GridSheet />
+      </div>
     </SheetProvider>
   );
 };
 
-const meta: Meta = {
+const meta = {
   title: 'plugins/plugin-sheet/GridSheet',
   component: GridSheet,
   decorators: [
-    withClientProvider({ types: [SheetType], createSpace: true }),
-    withComputeGraphDecorator(),
     withTheme,
-    withLayout({ fullscreen: true, classNames: 'grid' }),
+    withClientProvider({ types: [Sheet.Sheet], createSpace: true }),
+    withComputeGraphDecorator({ plugins: testFunctionPlugins }),
     withPluginManager({
       plugins: [IntentPlugin()],
     }),
   ],
-  parameters: { translations },
-};
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof GridSheet>;
 
 export default meta;
+
+type Story = StoryObj<typeof meta>;

package/src/components/GridSheet/GridSheet.tsx

@@ -3,42 +3,43 @@
 //
 
 import React, {
+  type FocusEvent,
+  type KeyboardEvent,
+  type MouseEvent,
+  type WheelEvent,
   useCallback,
   useMemo,
   useRef,
   useState,
-  type FocusEvent,
-  type KeyboardEvent,
-  type WheelEvent,
-  type MouseEvent,
 } from 'react';
 
 import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { rangeToA1Notation, type CellRange } from '@dxos/compute';
+import { type CellRange, rangeToA1Notation } from '@dxos/compute';
 import { defaultColSize, defaultRowSize } from '@dxos/lit-grid';
 import { DropdownMenu, Icon, useTranslation } from '@dxos/react-ui';
 import { useAttention } from '@dxos/react-ui-attention';
 import {
-  closestCell,
-  editorKeys,
-  parseCellIndex,
-  Grid,
-  GridCellEditor,
+  type DxGridCellIndex,
   type DxGridElement,
   type DxGridPosition,
-  type DxGridCellIndex,
-  type EditorKeyHandler,
   type EditorBlurHandler,
+  type EditorKeyHandler,
+  Grid,
+  GridCellEditor,
   type GridContentProps,
+  closestCell,
+  editorKeys,
+  parseCellIndex,
 } from '@dxos/react-ui-grid';
 
-import { colLabelCell, rowLabelCell, useSheetModelDxGridProps } from './util';
-import { rangeExtension, sheetExtension, type RangeController } from '../../extensions';
+import { type RangeController, rangeExtension, sheetExtension } from '../../extensions';
 import { useSelectThreadOnCellFocus, useUpdateFocusedCellOnThreadSelection } from '../../integrations';
-import { SHEET_PLUGIN } from '../../meta';
+import { meta } from '../../meta';
 import { DEFAULT_COLS, DEFAULT_ROWS, SheetAction } from '../../types';
 import { useSheetContext } from '../SheetContext';
 
+import { colLabelCell, rowLabelCell, useSheetModelDxGridProps } from './util';
+
 const inertPosition: DxGridPosition = { plane: 'grid', col: 0, row: 0 };
 
 const initialCells = {
@@ -59,16 +60,16 @@ const frozen = {
 };
 
 const sheetColDefault = {
-  frozenColsStart: { size: 48, readonly: true },
+  frozenColsStart: { size: 48, readonly: true, focusUnfurl: false },
   grid: { size: defaultColSize, resizeable: true },
 };
 const sheetRowDefault = {
-  frozenRowsStart: { size: defaultRowSize, readonly: true },
+  frozenRowsStart: { size: defaultRowSize, readonly: true, focusUnfurl: false },
   grid: { size: defaultRowSize, resizeable: true },
 };
 
 export const GridSheet = () => {
-  const { t } = useTranslation(SHEET_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const { id, model, editing, setCursor, setRange, cursor, cursorFallbackRange, activeRefs, ignoreAttention } =
     useSheetContext();
   // NOTE(thure): using `useState` instead of `useRef` works with refs provided by `@lit/react` and gives us
@@ -76,7 +77,7 @@ export const GridSheet = () => {
   const [dxGrid, setDxGrid] = useState<DxGridElement | null>(null);
   const [extraplanarFocus, setExtraplanarFocus] = useState<DxGridPosition | null>(null);
   const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const rangeController = useRef<RangeController>();
+  const rangeController = useRef<RangeController>(null);
   const { hasAttention } = useAttention(id);
 
   const handleFocus = useCallback(
@@ -278,7 +279,7 @@ export const GridSheet = () => {
 
   const { columns, rows } = useSheetModelDxGridProps(dxGrid, model);
 
-  const extension = useMemo(
+  const extensions = useMemo(
     () => [
       editorKeys({ onClose: handleClose, ...(editing?.initialContent && { onNav: handleClose }) }),
       sheetExtension({ functions: model.graph.getFunctions() }),
@@ -307,8 +308,8 @@ export const GridSheet = () => {
 
   return (
     // TODO(thure): Why are Table’s and Sheet’s editor boxes off by 1px?
-    <div role='none' className='relative min-bs-0 [&_.cm-editor]:!border-lb [&_.cm-editor]:!border-transparent '>
-      <GridCellEditor getCellContent={getCellContent} extension={extension} onBlur={handleBlur} />
+    <div role='none' className='relative min-bs-0 [&_.cm-editor]:!border-lb [&_.cm-editor]:!border-transparent'>
+      <GridCellEditor getCellContent={getCellContent} extensions={extensions} onBlur={handleBlur} />
       <Grid.Content
         initialCells={initialCells}
         limitColumns={DEFAULT_COLS}

package/src/components/GridSheet/SheetCellEditor.stories.tsx

@@ -2,53 +2,48 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
-import React, { useEffect, useMemo, useState } from 'react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useMemo, useState } from 'react';
 
 import { Client } from '@dxos/client';
 import { createDocAccessor } from '@dxos/client/echo';
 import { defaultFunctions } from '@dxos/compute';
 import { getRegisteredFunctionNames } from '@dxos/compute/testing';
+import { useAsyncEffect } from '@dxos/react-hooks';
+import { withTheme } from '@dxos/react-ui/testing';
 import { automerge } from '@dxos/react-ui-editor';
 import { CellEditor, type CellEditorProps } from '@dxos/react-ui-grid';
-import { withTheme } from '@dxos/storybook-utils';
 
 import { sheetExtension } from '../../extensions';
-import { createSheet, SheetType } from '../../types';
-
-type StoryProps = CellEditorProps;
+import { Sheet } from '../../types';
 
-const Story = ({ value, ...props }: StoryProps) => {
-  const extension = useMemo(() => {
+const DefaultStory = ({ value, ...props }: CellEditorProps) => {
+  const extensions = useMemo(() => {
     const functionNames = getRegisteredFunctionNames();
     const functions = defaultFunctions.filter(({ name }) => functionNames.includes(name));
     return [sheetExtension({ functions })];
   }, []);
 
-  return <CellEditor {...props} value={value} extension={extension} />;
+  return <CellEditor {...props} value={value} extensions={extensions} />;
 };
 
-const AutomergeStory = ({ value, ...props }: StoryProps) => {
+const AutomergeStory = ({ value, ...props }: CellEditorProps) => {
   const cell = 'A1';
-  const [object, setObject] = useState<SheetType>();
-  useEffect(() => {
-    setTimeout(async () => {
-      const client = new Client({ types: [SheetType] });
-      await client.initialize();
-      await client.halo.createIdentity();
-      const space = await client.spaces.create();
-
-      const sheet = createSheet();
-      sheet.name = 'Test';
-      sheet.cells[cell] = { value };
-      space.db.add(sheet);
-      setObject(sheet);
-    });
+  const [object, setObject] = useState<Sheet.Sheet>();
+  useAsyncEffect(async () => {
+    const client = new Client({ types: [Sheet.Sheet] });
+    await client.initialize();
+    await client.halo.createIdentity();
+    const space = await client.spaces.create();
+
+    const sheet = Sheet.make();
+    sheet.name = 'Test';
+    sheet.cells[cell] = { value };
+    space.db.add(sheet);
+    setObject(sheet);
   }, [value]);
 
-  const extension = useMemo(() => {
+  const extensions = useMemo(() => {
     if (!object) {
       return [];
     }
@@ -59,35 +54,38 @@ const AutomergeStory = ({ value, ...props }: StoryProps) => {
     return [automerge(accessor), sheetExtension({ functions })];
   }, [object]);
 
-  return <CellEditor {...props} value={value} extension={extension} />;
+  return <CellEditor {...props} value={value} extensions={extensions} />;
 };
 
-export const Default = {};
+const meta = {
+  title: 'plugins/plugin-sheet/CellEditor',
+
+  decorators: [withTheme],
+  component: CellEditor,
+  render: DefaultStory,
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
 
-export const AutoComplete = {
+export const Default: Story = {};
+
+export const AutoComplete: Story = {
   args: {
     value: '=SUM',
   },
 };
 
-export const Formatting = {
+export const Formatting: Story = {
   args: {
     value: '=SUM(A1:A2, 100, TRUE, "100", SUM(A1:A2, B1:B2))',
   },
 };
 
-export const Automerge = {
-  render: (args: StoryProps) => <AutomergeStory {...args} />,
+export const Automerge: Story = {
+  render: AutomergeStory,
   args: {
     value: '=SUM(A1:A2, 100, TRUE, "100", SUM(A1:A2, B1:B2))',
   },
 };
-
-const meta: Meta = {
-  title: 'plugins/plugin-sheet/CellEditor',
-  component: CellEditor,
-  decorators: [withTheme],
-  render: (args: StoryProps) => <Story {...args} />,
-};
-
-export default meta;

package/src/components/GridSheet/util.ts

@@ -6,18 +6,18 @@ import { useEffect, useState } from 'react';
 
 import { inRange } from '@dxos/compute';
 import { createDocAccessor } from '@dxos/react-client/echo';
-import { parseValue, cellClassesForFieldType } from '@dxos/react-ui-form';
+import { cellClassesForFieldType, parseValue } from '@dxos/react-ui-form';
 import {
-  type GridContentProps,
-  type DxGridElement,
   type DxGridAxisMeta,
+  type DxGridCellValue,
+  type DxGridElement,
   type DxGridPlane,
-  type DxGridPlaneRange,
   type DxGridPlaneCells,
-  type DxGridCellValue,
+  type DxGridPlaneRange,
+  type GridContentProps,
   colToA1Notation,
-  rowToA1Notation,
   commentedClassName,
+  rowToA1Notation,
 } from '@dxos/react-ui-grid';
 import { mx } from '@dxos/react-ui-theme';
 

package/src/components/RangeList/RangeList.tsx

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 import React, { useCallback } from 'react';
 
 import { rangeToA1Notation } from '@dxos/compute';
@@ -10,20 +10,20 @@ import { Callout, useTranslation } from '@dxos/react-ui';
 import { List } from '@dxos/react-ui-list';
 import { ghostHover } from '@dxos/react-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);
     },
@@ -37,7 +37,7 @@ export const RangeList = ({ sheet }: RangeListProps) => {
           <Callout.Title>{t('no ranges message')}</Callout.Title>
         </Callout.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/components/SheetContainer/SheetContainer.stories.tsx

@@ -2,28 +2,59 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta } from '@storybook/react-vite';
 import React from 'react';
 
-import { Capabilities, contributes, createResolver, IntentPlugin } from '@dxos/app-framework';
+import { Capabilities, IntentPlugin, contributes, createResolver } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
 import { GraphPlugin } from '@dxos/plugin-graph';
 import { fullyQualifiedId, useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
+import { withTheme } from '@dxos/react-ui/testing';
 import { AttendableContainer } from '@dxos/react-ui-attention';
 import { withAttention } from '@dxos/react-ui-attention/testing';
-import { withTheme, withLayout } from '@dxos/storybook-utils';
 
-import { SheetContainer } from './SheetContainer';
 import { createTestCells, useTestSheet, withComputeGraphDecorator } from '../../testing';
 import { translations } from '../../translations';
-import { SheetAction, SheetType } from '../../types';
+import { Sheet, SheetAction } from '../../types';
 import { useComputeGraph } from '../ComputeGraph';
 import { RangeList } from '../RangeList';
 
-export const Basic = () => {
+import { SheetContainer } from './SheetContainer';
+
+const meta = {
+  title: 'plugins/plugin-sheet/SheetContainer',
+  component: SheetContainer,
+  decorators: [
+    withTheme,
+    withClientProvider({ types: [Sheet.Sheet], createSpace: true }),
+    withComputeGraphDecorator(),
+    withAttention,
+    // TODO(wittjosiah): Consider whether we should refactor component so story doesn't need to depend on intents.
+    withPluginManager({
+      plugins: [IntentPlugin(), GraphPlugin()],
+      capabilities: [
+        contributes(
+          Capabilities.IntentResolver,
+          createResolver({
+            intent: SheetAction.DropAxis,
+            resolve: ({ model, axis, axisIndex }) => {
+              model[axis === 'col' ? 'dropColumn' : 'dropRow'](axisIndex);
+            },
+          }),
+        ),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof SheetContainer>;
+
+export default meta;
+
+export const Default = () => {
   const space = useSpace();
   const graph = useComputeGraph(space);
   const sheet = useTestSheet(space, graph, { cells: createTestCells() });
@@ -33,7 +64,7 @@ export const Basic = () => {
 
   return (
     <AttendableContainer id={fullyQualifiedId(sheet)} classNames='contents'>
-      <SheetContainer space={space} sheet={sheet} role='article' ignoreAttention />
+      <SheetContainer space={space} sheet={sheet} role='story' ignoreAttention />
     </AttendableContainer>
   );
 };
@@ -48,8 +79,8 @@ export const Spec = () => {
 
   return (
     <AttendableContainer id={fullyQualifiedId(sheet)} classNames='contents'>
-      <div role='none' className='grid grid-rows-[66%_33%] grid-cols-1'>
-        <SheetContainer space={space} sheet={sheet} role='article' ignoreAttention />
+      <div role='none' className='grid grid-rows-[66%_33%] bs-full grid-cols-1'>
+        <SheetContainer space={space} sheet={sheet} role='story' ignoreAttention />
         <div role='none' data-testid='grid.range-list'>
           <RangeList sheet={sheet} />
         </div>
@@ -57,33 +88,3 @@ export const Spec = () => {
     </AttendableContainer>
   );
 };
-
-const meta: Meta = {
-  title: 'plugins/plugin-sheet/SheetContainer',
-  component: SheetContainer,
-  decorators: [
-    withClientProvider({ types: [SheetType], createSpace: true }),
-    withComputeGraphDecorator(),
-    withTheme,
-    withLayout({ fullscreen: true, classNames: 'grid' }),
-    withAttention,
-    // TODO(wittjosiah): Consider whether we should refactor component so story doesn't need to depend on intents.
-    withPluginManager({
-      plugins: [IntentPlugin(), GraphPlugin()],
-      capabilities: [
-        contributes(
-          Capabilities.IntentResolver,
-          createResolver({
-            intent: SheetAction.DropAxis,
-            resolve: ({ model, axis, axisIndex }) => {
-              model[axis === 'col' ? 'dropColumn' : 'dropRow'](axisIndex);
-            },
-          }),
-        ),
-      ],
-    }),
-  ],
-  parameters: { translations },
-};
-
-export default meta;

package/src/components/SheetContainer/SheetContainer.tsx

@@ -4,10 +4,10 @@
 
 import React from 'react';
 
-import { fullyQualifiedId, type Space } from '@dxos/react-client/echo';
+import { type Space, fullyQualifiedId } from '@dxos/react-client/echo';
 import { StackItem } from '@dxos/react-ui-stack';
 
-import { type SheetType } from '../../types';
+import { type Sheet } from '../../types';
 import { useComputeGraph } from '../ComputeGraph';
 import { FunctionEditor } from '../FunctionEditor';
 import { GridSheet } from '../GridSheet';
@@ -16,7 +16,7 @@ import { SheetToolbar } from '../SheetToolbar';
 
 export type SheetContainerProps = {
   space: Space;
-  sheet: SheetType;
+  sheet: Sheet.Sheet;
   role?: string;
   ignoreAttention?: boolean;
 };
@@ -26,7 +26,11 @@ export const SheetContainer = ({ space, sheet, role, ignoreAttention }: SheetCon
 
   return graph ? (
     <SheetProvider sheet={sheet} graph={graph} ignoreAttention={ignoreAttention}>
-      <StackItem.Content toolbar statusbar {...(role === 'section' && { classNames: 'aspect-video' })}>
+      <StackItem.Content
+        toolbar
+        statusbar
+        classNames={[role === 'section' && 'aspect-video', role === 'story' && 'bs-full']}
+      >
         <SheetToolbar id={fullyQualifiedId(sheet)} />
         <GridSheet />
         <FunctionEditor />

package/src/components/SheetContext/SheetContext.tsx

@@ -4,7 +4,7 @@
 
 import React, { type PropsWithChildren, createContext, useCallback, useContext, useState } from 'react';
 
-import { type ComputeGraph, type CellAddress, type CellRange, type CompleteCellRange } from '@dxos/compute';
+import { type CellAddress, type CellRange, type CompleteCellRange, type ComputeGraph } from '@dxos/compute';
 import { invariant } from '@dxos/invariant';
 import { fullyQualifiedId } from '@dxos/react-client/echo';
 import {
@@ -16,7 +16,7 @@ import {
 } from '@dxos/react-ui-grid';
 
 import { type SheetModel, useSheetModel } from '../../model';
-import { type SheetType } from '../../types';
+import { type Sheet } from '../../types';
 
 export type SheetContextValue = {
   id: string;
@@ -114,7 +114,7 @@ const SheetProviderImpl = ({
 
 export type SheetProviderProps = {
   graph: ComputeGraph;
-  sheet: SheetType;
+  sheet: Sheet.Sheet;
   readonly?: boolean;
   ignoreAttention?: boolean;
 } & Pick<SheetContextValue, 'onInfo'>;

package/src/components/SheetToolbar/SheetToolbar.stories.tsx

@@ -2,28 +2,34 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
-import { SheetToolbar } from './SheetToolbar';
 import { translations } from '../../translations';
 
+import { SheetToolbar } from './SheetToolbar';
+
 const DefaultStory = () => {
-  return <SheetToolbar id='test' />;
+  // TODO(wittjosiah): Depends on SheetProvider.
+  // return <SheetToolbar id='test' />;
+  return <>TODO</>;
 };
 
-export const Default = {};
-
-const meta: Meta = {
+const meta = {
   title: 'plugins/plugin-sheet/Toolbar',
-  component: SheetToolbar,
+  component: SheetToolbar as any,
   render: DefaultStory,
-  decorators: [withTheme, withLayout()],
-  parameters: { translations, layout: 'fullscreen' },
-};
+  decorators: [withTheme],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};