@dxos/plugin-sheet 0.6.11 → 0.6.12-main.568932b

package/src/components/GridSheet/GridSheet.tsx

@@ -0,0 +1,171 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useCallback, useMemo, useRef } from 'react';
+
+import {
+  type DxGridElement,
+  Grid,
+  type GridContentProps,
+  type GridScopedProps,
+  useGridContext,
+} from '@dxos/react-ui-grid';
+
+import { colLabelCell, dxGridCellIndexToSheetCellAddress, rowLabelCell, useSheetModelDxGridProps } from './util';
+import { rangeToA1Notation, type CellRange } from '../../defs';
+import { type ComputeGraph } from '../../graph';
+import { useFormattingModel, useSheetModel, type UseSheetModelOptions } from '../../hooks';
+import { type SheetModel, type FormattingModel } from '../../model';
+import { type SheetType } from '../../types';
+import {
+  CellEditor,
+  type CellEditorProps,
+  type CellRangeNotifier,
+  editorKeys,
+  type EditorKeysProps,
+  rangeExtension,
+  sheetExtension,
+} from '../CellEditor';
+
+const GridSheetCellEditor = ({
+  model,
+  extension,
+  __gridScope,
+}: GridScopedProps<Pick<CellEditorProps, 'extension'> & { model: SheetModel }>) => {
+  const { id, editing, setEditing, editBox } = useGridContext('GridSheetCellEditor', __gridScope);
+  const cell = dxGridCellIndexToSheetCellAddress(editing);
+
+  return editing ? (
+    <CellEditor
+      variant='grid'
+      value={editing.initialContent ?? (cell ? model.getCellText(cell) : undefined)}
+      autoFocus
+      box={editBox}
+      onBlur={() => setEditing(null)}
+      extension={extension}
+      gridId={id}
+    />
+  ) : null;
+};
+
+const initialCells = {
+  grid: {},
+  frozenColsStart: [...Array(64)].reduce((acc, _, i) => {
+    acc[`0,${i}`] = rowLabelCell(i);
+    return acc;
+  }, {}),
+  frozenRowsStart: [...Array(12)].reduce((acc, _, i) => {
+    acc[`${i},0`] = colLabelCell(i);
+    return acc;
+  }, {}),
+};
+
+const frozen = {
+  frozenColsStart: 1,
+  frozenRowsStart: 1,
+};
+
+const sheetRowDefault = { grid: { size: 32, resizeable: true } };
+const sheetColDefault = { frozenColsStart: { size: 48 }, grid: { size: 180, resizeable: true } };
+
+const GridSheetImpl = ({
+  model,
+  formatting,
+  __gridScope,
+}: GridScopedProps<{ model: SheetModel; formatting: FormattingModel }>) => {
+  const { editing, setEditing } = useGridContext('GridSheetCellEditor', __gridScope);
+  const dxGrid = useRef<DxGridElement | null>(null);
+  const rangeNotifier = useRef<CellRangeNotifier>();
+
+  // TODO(burdon): Validate formula before closing: hf.validateFormula();
+  const handleClose = useCallback<NonNullable<EditorKeysProps['onClose']> | NonNullable<EditorKeysProps['onNav']>>(
+    (value, { key, shift }) => {
+      if (value !== undefined) {
+        model.setValue(dxGridCellIndexToSheetCellAddress(editing)!, value);
+      }
+      setEditing(null);
+      const axis = ['Enter', 'ArrowUp', 'ArrowDown'].includes(key)
+        ? 'row'
+        : ['Tab', 'ArrowLeft', 'ArrowRight'].includes(key)
+          ? 'col'
+          : undefined;
+      const delta = key.startsWith('Arrow') ? (['ArrowUp', 'ArrowLeft'].includes(key) ? -1 : 1) : shift ? -1 : 1;
+      dxGrid.current?.refocus(axis, delta);
+    },
+    [model, editing, setEditing],
+  );
+
+  const handleAxisResize = useCallback<NonNullable<GridContentProps['onAxisResize']>>(
+    ({ axis, size, index: numericIndex }) => {
+      if (axis === 'row') {
+        const rowId = model.sheet.rows[parseInt(numericIndex)];
+        model.sheet.rowMeta[rowId] ??= {};
+        model.sheet.rowMeta[rowId].size = size;
+      } else {
+        const columnId = model.sheet.columns[parseInt(numericIndex)];
+        model.sheet.columnMeta[columnId] ??= {};
+        model.sheet.columnMeta[columnId].size = size;
+      }
+    },
+    [model],
+  );
+
+  const handleSelect = useCallback<NonNullable<GridContentProps['onSelect']>>(
+    ({ minCol, maxCol, minRow, maxRow }) => {
+      if (editing) {
+        const range: CellRange = { from: { col: minCol, row: minRow } };
+        if (minCol !== maxCol || minRow !== maxRow) {
+          range.to = { col: maxCol, row: maxRow };
+        }
+        // Update range selection in formula.
+        rangeNotifier.current?.(rangeToA1Notation(range));
+      }
+    },
+    [editing],
+  );
+
+  const { columns, rows } = useSheetModelDxGridProps(dxGrid, model, formatting);
+
+  const extension = useMemo(
+    () => [
+      editorKeys({ onClose: handleClose, ...(editing?.initialContent && { onNav: handleClose }) }),
+      sheetExtension({ functions: model.graph.getFunctions() }),
+      rangeExtension((fn) => (rangeNotifier.current = fn)),
+    ],
+    [model, handleClose, editing],
+  );
+
+  return (
+    <>
+      <GridSheetCellEditor model={model} extension={extension} />
+      <Grid.Content
+        initialCells={initialCells}
+        columns={columns}
+        rows={rows}
+        onAxisResize={handleAxisResize}
+        onSelect={handleSelect}
+        rowDefault={sheetRowDefault}
+        columnDefault={sheetColDefault}
+        frozen={frozen}
+        ref={dxGrid}
+      />
+    </>
+  );
+};
+
+export type GridSheetProps = { graph?: ComputeGraph; sheet?: SheetType } & UseSheetModelOptions;
+
+export const GridSheet = ({ graph, sheet, ...options }: GridSheetProps) => {
+  const model = useSheetModel(graph, sheet, options);
+  const formatting = useFormattingModel(model);
+  if (!model || !formatting) {
+    return null;
+  }
+
+  return (
+    <Grid.Root id={model.id}>
+      <GridSheetImpl model={model} formatting={formatting} />
+    </Grid.Root>
+  );
+};

package/src/components/GridSheet/util.ts

@@ -0,0 +1,148 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type MutableRefObject, useEffect, useLayoutEffect, useState } from 'react';
+
+import { createDocAccessor } from '@dxos/react-client/echo';
+import {
+  type GridEditing,
+  type GridContentProps,
+  type DxGridElement,
+  type DxGridAxisMeta,
+  type DxGridPlane,
+  type DxGridPlaneRange,
+  type DxGridPlaneCells,
+  colToA1Notation,
+  rowToA1Notation,
+} from '@dxos/react-ui-grid';
+import { mx } from '@dxos/react-ui-theme';
+
+import { type CellAddress } from '../../defs';
+import { type SheetModel, type FormattingModel } from '../../model';
+
+export const dxGridCellIndexToSheetCellAddress = (gridEditing: GridEditing): CellAddress | null => {
+  if (!gridEditing) {
+    return null;
+  }
+  const [colStr, rowStr] = gridEditing.index.split(',');
+  return {
+    col: parseInt(colStr),
+    row: parseInt(rowStr),
+  };
+};
+
+const createDxGridColumns = (model: SheetModel): DxGridAxisMeta => {
+  return model.sheet.columns.reduce(
+    (acc: DxGridAxisMeta, columnId, numericIndex) => {
+      if (model.sheet.columnMeta[columnId] && model.sheet.columnMeta[columnId].size) {
+        acc.grid[numericIndex] = { size: model.sheet.columnMeta[columnId].size, resizeable: true };
+      }
+      return acc;
+    },
+    { grid: {} },
+  );
+};
+
+const createDxGridRows = (model: SheetModel): DxGridAxisMeta => {
+  return model.sheet.rows.reduce(
+    (acc: DxGridAxisMeta, rowId, numericIndex) => {
+      if (model.sheet.rowMeta[rowId] && model.sheet.rowMeta[rowId].size) {
+        acc.grid[numericIndex] = { size: model.sheet.rowMeta[rowId].size, resizeable: true };
+      }
+      return acc;
+    },
+    { grid: {} },
+  );
+};
+
+const gridCellGetter = (model: SheetModel, formatting: FormattingModel) => {
+  // TODO(thure): Actually use the cache.
+  const cachedGridCells: DxGridPlaneCells = {};
+  return (nextBounds: DxGridPlaneRange): DxGridPlaneCells => {
+    [...Array(nextBounds.end.col - nextBounds.start.col)].forEach((_, c0) => {
+      return [...Array(nextBounds.end.row - nextBounds.start.row)].forEach((_, r0) => {
+        const col = nextBounds.start.col + c0;
+        const row = nextBounds.start.row + r0;
+        const cell = formatting.getFormatting({ col, row });
+        if (cell.value) {
+          cachedGridCells;
+          cachedGridCells[`${col},${row}`] = { value: cell.value, className: mx(cell.classNames) };
+        }
+      });
+    });
+    return cachedGridCells;
+  };
+};
+
+export const rowLabelCell = (row: number) => ({
+  value: rowToA1Notation(row),
+  className: 'text-end !pie-1',
+  resizeHandle: 'row',
+});
+
+export const colLabelCell = (col: number) => ({ value: colToA1Notation(col), resizeHandle: 'col' });
+
+const cellGetter = (model: SheetModel, formatting: FormattingModel) => {
+  const getGridCells = gridCellGetter(model, formatting);
+  return (nextBounds: DxGridPlaneRange, plane: DxGridPlane): DxGridPlaneCells => {
+    switch (plane) {
+      case 'grid':
+        return getGridCells(nextBounds);
+      case 'frozenColsStart':
+        return [...Array(nextBounds.end.row - nextBounds.start.row)].reduce((acc, _, r0) => {
+          const r = nextBounds.start.row + r0;
+          acc[`0,${r}`] = rowLabelCell(r);
+          return acc;
+        }, {});
+      case 'frozenRowsStart':
+        return [...Array(nextBounds.end.col - nextBounds.start.col)].reduce((acc, _, c0) => {
+          const c = nextBounds.start.col + c0;
+          acc[`${c},0`] = colLabelCell(c);
+          return acc;
+        }, {});
+      default:
+        return {};
+    }
+  };
+};
+
+export const useSheetModelDxGridProps = (
+  dxGridRef: MutableRefObject<DxGridElement | null>,
+  model: SheetModel,
+  formatting: FormattingModel,
+): Pick<GridContentProps, 'columns' | 'rows'> => {
+  const [columns, setColumns] = useState<DxGridAxisMeta>(createDxGridColumns(model));
+  const [rows, setRows] = useState<DxGridAxisMeta>(createDxGridColumns(model));
+
+  useLayoutEffect(() => {
+    const cellsAccessor = createDocAccessor(model.sheet, ['cells']);
+    if (dxGridRef.current) {
+      dxGridRef.current.getCells = cellGetter(model, formatting);
+    }
+    const handleCellsUpdate = () => {
+      dxGridRef.current?.requestUpdate('initialCells');
+    };
+    cellsAccessor.handle.addListener('change', handleCellsUpdate);
+    return () => cellsAccessor.handle.removeListener('change', handleCellsUpdate);
+  }, [model, formatting]);
+
+  useEffect(() => {
+    const columnMetaAccessor = createDocAccessor(model.sheet, ['columnMeta']);
+    const rowMetaAccessor = createDocAccessor(model.sheet, ['rowMeta']);
+    const handleColumnMetaUpdate = () => {
+      setColumns(createDxGridColumns(model));
+    };
+    const handleRowMetaUpdate = () => {
+      setRows(createDxGridRows(model));
+    };
+    columnMetaAccessor.handle.addListener('change', handleColumnMetaUpdate);
+    rowMetaAccessor.handle.addListener('change', handleRowMetaUpdate);
+    return () => {
+      columnMetaAccessor.handle.removeListener('change', handleColumnMetaUpdate);
+      rowMetaAccessor.handle.removeListener('change', handleRowMetaUpdate);
+    };
+  }, [model]);
+
+  return { columns, rows };
+};

package/src/components/Sheet/Sheet.stories.tsx

@@ -4,31 +4,34 @@
 
 import '@dxos-theme';
 
-import { type Decorator } from '@storybook/react';
-import React, { useContext, useEffect, useState } from 'react';
+import React, { useState } from 'react';
 
-import { Client } from '@dxos/client';
-import { type EchoReactiveObject } from '@dxos/echo-schema';
 import { log } from '@dxos/log';
-import { getSpace, type Space } from '@dxos/react-client/echo';
+import { useSpace } from '@dxos/react-client/echo';
+import { withClientProvider } from '@dxos/react-client/testing';
 import { Button } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
-import { withTheme, withLayout } from '@dxos/storybook-utils';
+import { withLayout, withTheme } from '@dxos/storybook-utils';
 
 import { Sheet } from './Sheet';
 import { type SizeMap } from './grid';
 import { useSheetContext } from './sheet-context';
-import { createTestSheet, testSheetName } from '../../testing';
-import { ValueTypeEnum, SheetType } from '../../types';
-import { type ComputeGraph, createComputeGraph } from '../ComputeGraph';
-// TODO(wittjosiah): Refactor. This is not exported from ./components due to depending on ECHO.
-import { ComputeGraphContext, ComputeGraphContextProvider, useComputeGraph } from '../ComputeGraph/graph-context';
+import { addressToIndex, rangeToIndex } from '../../defs';
+import { type ComputeGraph } from '../../graph';
+import { testFunctionPlugins } from '../../graph/testing';
+import { useComputeGraph } from '../../hooks';
+import { createTestCells, useTestSheet, withComputeGraphDecorator } from '../../testing';
+import { SheetType, ValueTypeEnum } from '../../types';
 import { Toolbar, type ToolbarActionHandler } from '../Toolbar';
 
 // TODO(burdon): Allow toolbar to access sheet context; provide state for current cursor/range.
-const SheetWithToolbar = ({ debug, space }: { debug?: boolean; space: Space }) => {
+const SheetWithToolbar = ({ graph, debug }: { graph: ComputeGraph; debug?: boolean }) => {
   const { model, cursor, range } = useSheetContext();
 
+  const handleRefresh = () => {
+    // graph?.refresh(); // TODO(burdon): ???
+  };
+
   // TODO(burdon): Factor out.
   const handleAction: ToolbarActionHandler = ({ type }) => {
     log.info('action', { type, cursor, range });
@@ -36,7 +39,7 @@ const SheetWithToolbar = ({ debug, space }: { debug?: boolean; space: Space }) =
       return;
     }
 
-    const idx = range ? model.rangeToIndex(range) : model.addressToIndex(cursor);
+    const idx = range ? rangeToIndex(model.sheet, range) : addressToIndex(model.sheet, cursor);
     model.sheet.formatting[idx] ??= {};
     const format = model.sheet.formatting[idx];
 
@@ -75,14 +78,12 @@ const SheetWithToolbar = ({ debug, space }: { debug?: boolean; space: Space }) =
         format.precision = 2;
         break;
       }
+      case 'comment': {
+        break;
+      }
     }
   };
 
-  const graph = useComputeGraph(space);
-  const handleRefresh = () => {
-    graph.refresh();
-  };
-
   return (
     <div className='flex flex-col overflow-hidden'>
       <Toolbar.Root onAction={handleAction}>
@@ -99,56 +100,43 @@ const SheetWithToolbar = ({ debug, space }: { debug?: boolean; space: Space }) =
   );
 };
 
-const withGraphDecorator: Decorator = (Story) => {
-  const [graphs, setGraphs] = useState<Record<string, ComputeGraph>>({});
-
-  const setGraph = (key: string, graph: ComputeGraph) => {
-    if (!graph.hf.doesSheetExist(testSheetName)) {
-      const sheetName = graph.hf.addSheet(testSheetName);
-      const sheet = graph.hf.getSheetId(sheetName)!;
-      graph.hf.setCellContents({ sheet, col: 0, row: 0 }, Math.random());
-    }
-
-    setGraphs((graphs) => ({ ...graphs, [key]: graph }));
-  };
-
-  return (
-    <ComputeGraphContextProvider graphs={graphs} setGraph={setGraph}>
-      <Story />
-    </ComputeGraphContextProvider>
-  );
-};
-
 export default {
   title: 'plugin-sheet/Sheet',
   component: Sheet,
-  decorators: [withTheme, withLayout({ fullscreen: true, tooltips: true, classNames: 'inset-4' }), withGraphDecorator],
+  decorators: [
+    withClientProvider({ types: [SheetType], createIdentity: true }),
+    withComputeGraphDecorator({ plugins: testFunctionPlugins }),
+    withTheme,
+    withLayout({ fullscreen: true, tooltips: true, classNames: 'inset-4' }),
+  ],
 };
 
 export const Default = () => {
   const [debug, setDebug] = useState(false);
-  const sheet = useTestSheet();
-  const space = getSpace(sheet);
-  if (!sheet || !space) {
+  const space = useSpace();
+  const graph = useComputeGraph(space);
+  const sheet = useTestSheet(space, graph, { cells: createTestCells() });
+  if (!graph || !sheet) {
     return null;
   }
 
   return (
-    <Sheet.Root sheet={sheet} space={space} onInfo={() => setDebug((debug) => !debug)}>
-      <SheetWithToolbar debug={debug} space={space} />
+    <Sheet.Root graph={graph} sheet={sheet} onInfo={() => setDebug((debug) => !debug)}>
+      <SheetWithToolbar graph={graph} debug={debug} />
     </Sheet.Root>
   );
 };
 
 export const Debug = () => {
-  const sheet = useTestSheet();
-  const space = getSpace(sheet);
-  if (!sheet || !space) {
+  const space = useSpace();
+  const graph = useComputeGraph(space);
+  const sheet = useTestSheet(space, graph, { cells: createTestCells() });
+  if (!graph || !sheet) {
     return null;
   }
 
   return (
-    <Sheet.Root sheet={sheet} space={space}>
+    <Sheet.Root graph={graph} sheet={sheet}>
       <Sheet.Main />
       <Sheet.Debug />
     </Sheet.Root>
@@ -157,14 +145,15 @@ export const Debug = () => {
 
 export const Rows = () => {
   const [rowSizes, setRowSizes] = useState<SizeMap>({});
-  const sheet = useTestSheet();
-  const space = getSpace(sheet);
-  if (!sheet || !space) {
+  const space = useSpace();
+  const graph = useComputeGraph(space);
+  const sheet = useTestSheet(space, graph);
+  if (!graph || !sheet) {
     return null;
   }
 
   return (
-    <Sheet.Root sheet={sheet} space={space}>
+    <Sheet.Root graph={graph} sheet={sheet}>
       <Sheet.Rows
         rows={sheet.rows}
         sizes={rowSizes}
@@ -176,14 +165,15 @@ export const Rows = () => {
 
 export const Columns = () => {
   const [columnSizes, setColumnSizes] = useState<SizeMap>({});
-  const sheet = useTestSheet();
-  const space = getSpace(sheet);
-  if (!sheet || !space) {
+  const space = useSpace();
+  const graph = useComputeGraph(space);
+  const sheet = useTestSheet(space, graph);
+  if (!graph || !sheet) {
     return null;
   }
 
   return (
-    <Sheet.Root sheet={sheet} space={space}>
+    <Sheet.Root graph={graph} sheet={sheet}>
       <Sheet.Columns
         columns={sheet.columns}
         sizes={columnSizes}
@@ -194,18 +184,19 @@ export const Columns = () => {
 };
 
 export const Main = () => {
-  const sheet = useTestSheet();
-  const space = getSpace(sheet);
-  if (!sheet || !space) {
+  const space = useSpace();
+  const graph = useComputeGraph(space);
+  const sheet = useTestSheet(space, graph, { cells: createTestCells() });
+  if (!graph || !sheet) {
     return null;
   }
 
   return (
-    <Sheet.Root sheet={sheet} space={space}>
+    <Sheet.Root graph={graph} sheet={sheet}>
       <Sheet.Grid
         size={{
           numRows: 50,
-          numColumns: 26,
+          numCols: 26,
         }}
         rows={sheet.rows}
         columns={sheet.columns}
@@ -258,30 +249,3 @@ export const GridLayout = () => {
 const Cell = ({ className, label }: { className?: string; label: string }) => (
   <div className={mx('flex items-center justify-center border', className)}>{label}</div>
 );
-
-const useTestSheet = () => {
-  const { graphs, setGraph } = useContext(ComputeGraphContext);
-  const [sheet, setSheet] = useState<EchoReactiveObject<SheetType>>();
-  useEffect(() => {
-    const t = setTimeout(async () => {
-      const client = new Client();
-      await client.initialize();
-      await client.halo.createIdentity();
-      const space = await client.spaces.create();
-      client.addTypes([SheetType]);
-
-      const graph = graphs[space.id] ?? createComputeGraph();
-      if (!graphs[space.id]) {
-        setGraph(space.id, graph);
-      }
-
-      const sheet = await createTestSheet({ graph });
-      space.db.add(sheet);
-      setSheet(sheet);
-    });
-
-    return () => clearTimeout(t);
-  }, []);
-
-  return sheet;
-};