@dxos/plugin-sheet 0.8.4-main.ae835ea → 0.8.4-main.bc2380dfbc

package/src/model/sheet-model.ts

@@ -20,10 +20,10 @@ import {
   addressToA1Notation,
   createSheetName,
   isFormula,
-} from '@dxos/compute';
+} from '@dxos/compute-hyperformula';
 import { Resource } from '@dxos/context';
 import { Obj } from '@dxos/echo';
-import { FormatEnum, TypeEnum } from '@dxos/echo/internal';
+import { Format, TypeEnum } from '@dxos/echo/internal';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
@@ -38,22 +38,22 @@ import {
   insertIndices,
   mapFormulaIndicesToRefs,
   mapFormulaRefsToIndices,
-} from '../types';
-import { type Sheet, type SheetAction } from '../types';
+} from '#types';
+import { type Sheet, type SheetAction } from '#types';
 
 // TODO(burdon): Move to compute.
 // Map sheet types to system types.
 // https://hyperformula.handsontable.com/guide/types-of-values.html
 //  - https://github.com/handsontable/hyperformula/blob/master/src/Cell.ts (CellValueType)
 //  - https://github.com/handsontable/hyperformula/blob/master/src/interpreter/InterpreterValue.ts (NumberType)
-const typeMap: Record<string, { type: TypeEnum; format?: FormatEnum }> = {
+const typeMap: Record<string, { type: TypeEnum; format?: Format.TypeFormat }> = {
   BOOLEAN: { type: TypeEnum.Boolean },
   NUMBER_RAW: { type: TypeEnum.Number },
-  NUMBER_PERCENT: { type: TypeEnum.Number, format: FormatEnum.Percent },
-  NUMBER_CURRENCY: { type: TypeEnum.Number, format: FormatEnum.Currency },
-  NUMBER_DATETIME: { type: TypeEnum.String, format: FormatEnum.DateTime },
-  NUMBER_DATE: { type: TypeEnum.String, format: FormatEnum.Date },
-  NUMBER_TIME: { type: TypeEnum.String, format: FormatEnum.Time },
+  NUMBER_PERCENT: { type: TypeEnum.Number, format: Format.TypeFormat.Percent },
+  NUMBER_CURRENCY: { type: TypeEnum.Number, format: Format.TypeFormat.Currency },
+  NUMBER_DATETIME: { type: TypeEnum.String, format: Format.TypeFormat.DateTime },
+  NUMBER_DATE: { type: TypeEnum.String, format: Format.TypeFormat.Date },
+  NUMBER_TIME: { type: TypeEnum.String, format: Format.TypeFormat.Time },
 };
 
 const getTopLeft = (range: CellRange): CellAddress => {
@@ -122,7 +122,9 @@ export class SheetModel extends Resource {
    */
   protected override async _open(): Promise<void> {
     log('initialize', { id: this.id });
-    initialize(this._sheet);
+    Obj.update(this._sheet, (obj) => {
+      initialize(obj);
+    });
 
     this._graph.update.on((event) => {
       if (event.type === 'functionsUpdated') {
@@ -181,13 +183,19 @@ export class SheetModel extends Resource {
   }
 
   insertRows(i: number, n = 1): string[] {
-    const idx = insertIndices(this._sheet.rows, i, n, MAX_ROWS);
+    let idx: string[] = [];
+    Obj.update(this._sheet, (obj) => {
+      idx = insertIndices(obj.rows, i, n, MAX_ROWS);
+    });
     this.reset();
     return idx;
   }
 
   insertColumns(i: number, n = 1): string[] {
-    const idx = insertIndices(this._sheet.columns, i, n, MAX_COLS);
+    let idx: string[] = [];
+    Obj.update(this._sheet, (obj) => {
+      idx = insertIndices(obj.columns, i, n, MAX_COLS);
+    });
     this.reset();
     return idx;
   }
@@ -200,8 +208,10 @@ export class SheetModel extends Resource {
     const values = this.getCellValues(range).flat();
     const index = this._sheet.rows.indexOf(rowIndex);
     this.clear(range);
-    this._sheet.rows.splice(index, 1);
-    delete this._sheet.rowMeta[rowIndex];
+    Obj.update(this._sheet, (obj) => {
+      obj.rows.splice(index, 1);
+      delete obj.rowMeta[rowIndex];
+    });
     this.reset();
     return { axis: 'row', index, axisIndex: rowIndex, axisMeta: this._sheet.rowMeta[rowIndex], values };
   }
@@ -214,35 +224,43 @@ export class SheetModel extends Resource {
     const values = this.getCellValues(range).flat();
     const index = this._sheet.columns.indexOf(colIndex);
     this.clear(range);
-    this._sheet.columns.splice(index, 1);
-    delete this._sheet.columnMeta[colIndex];
+    Obj.update(this._sheet, (obj) => {
+      obj.columns.splice(index, 1);
+      delete obj.columnMeta[colIndex];
+    });
     this.reset();
     return { axis: 'col', index, axisIndex: colIndex, axisMeta: this._sheet.rowMeta[colIndex], values };
   }
 
   restoreRow({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis): void {
-    this._sheet.rows.splice(index, 0, axisIndex);
-    values.forEach((value, col) => {
-      if (value) {
-        this._sheet.cells[`${this._sheet.columns[col]}@${axisIndex}`] = { value };
+    Obj.update(this._sheet, (obj) => {
+      obj.rows.splice(index, 0, axisIndex);
+      values.forEach((value, col) => {
+        if (value) {
+          obj.cells[`${obj.columns[col]}@${axisIndex}`] = { value };
+        }
+      });
+
+      if (axisMeta) {
+        obj.rowMeta[axisIndex] = axisMeta;
       }
     });
-    if (axisMeta) {
-      this._sheet.rowMeta[axisIndex] = axisMeta;
-    }
     this.reset();
   }
 
   restoreColumn({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis): void {
-    this._sheet.columns.splice(index, 0, axisIndex);
-    values.forEach((value, row) => {
-      if (value) {
-        this._sheet.cells[`${axisIndex}@${this._sheet.rows[row]}`] = { value };
+    Obj.update(this._sheet, (obj) => {
+      obj.columns.splice(index, 0, axisIndex);
+      values.forEach((value, row) => {
+        if (value) {
+          obj.cells[`${axisIndex}@${obj.rows[row]}`] = { value };
+        }
+      });
+
+      if (axisMeta) {
+        obj.columnMeta[axisIndex] = axisMeta;
       }
     });
-    if (axisMeta) {
-      this._sheet.columnMeta[axisIndex] = axisMeta;
-    }
     this.reset();
   }
 
@@ -259,18 +277,22 @@ export class SheetModel extends Resource {
     const topLeft = getTopLeft(range);
     const values = this._iterRange(range, () => null);
     this._node.graph.hf.setCellContents(toSimpleCellAddress(this._node.sheetId, topLeft), values);
-    this._iterRange(range, (cell) => {
-      const idx = addressToIndex(this._sheet, cell);
-      delete this._sheet.cells[idx];
+    Obj.update(this._sheet, (obj) => {
+      this._iterRange(range, (cell) => {
+        const idx = addressToIndex(this._sheet, cell);
+        delete obj.cells[idx];
+      });
     });
   }
 
   cut(range: CellRange): void {
     invariant(this._node);
     this._node.graph.hf.cut(toModelRange(this._node.sheetId, range));
-    this._iterRange(range, (cell) => {
-      const idx = addressToIndex(this._sheet, cell);
-      delete this._sheet.cells[idx];
+    Obj.update(this._sheet, (obj) => {
+      this._iterRange(range, (cell) => {
+        const idx = addressToIndex(this._sheet, cell);
+        delete obj.cells[idx];
+      });
     });
   }
 
@@ -283,13 +305,15 @@ export class SheetModel extends Resource {
     invariant(this._node);
     if (!this._node.graph.hf.isClipboardEmpty()) {
       const changes = this._node.graph.hf.paste(toSimpleCellAddress(this._node.sheetId, cell));
-      for (const change of changes) {
-        if (change instanceof ExportedCellChange) {
-          const { address, newValue } = change;
-          const idx = addressToIndex(this._sheet, { row: address.row, col: address.col });
-          this._sheet.cells[idx] = { value: newValue };
+      Obj.update(this._sheet, (obj) => {
+        for (const change of changes) {
+          if (change instanceof ExportedCellChange) {
+            const { address, newValue } = change;
+            const idx = addressToIndex(this._sheet, { row: address.row, col: address.col });
+            obj.cells[idx] = { value: newValue };
+          }
         }
-      }
+      });
     }
   }
 
@@ -361,7 +385,7 @@ export class SheetModel extends Resource {
   /**
    * Get value type.
    */
-  getValueDescription(cell: CellAddress): { type: TypeEnum; format?: FormatEnum } | undefined {
+  getValueDescription(cell: CellAddress): { type: TypeEnum; format?: Format.TypeFormat } | undefined {
     invariant(this._node);
     const addr = toSimpleCellAddress(this._node.sheetId, cell);
     const type = this._node.graph.hf.getCellValueDetailedType(addr);
@@ -380,11 +404,15 @@ export class SheetModel extends Resource {
     // Reallocate if > current bounds.
     let refresh = false;
     if (cell.row >= this._sheet.rows.length) {
-      insertIndices(this._sheet.rows, cell.row, 1, MAX_ROWS);
+      Obj.update(this._sheet, (obj) => {
+        insertIndices(obj.rows, cell.row, 1, MAX_ROWS);
+      });
       refresh = true;
     }
     if (cell.col >= this._sheet.columns.length) {
-      insertIndices(this._sheet.columns, cell.col, 1, MAX_COLS);
+      Obj.update(this._sheet, (obj) => {
+        insertIndices(obj.columns, cell.col, 1, MAX_COLS);
+      });
       refresh = true;
     }
 
@@ -401,13 +429,17 @@ export class SheetModel extends Resource {
     // Insert into sheet.
     const idx = addressToIndex(this._sheet, cell);
     if (value === undefined || value === null) {
-      delete this._sheet.cells[idx];
+      Obj.update(this._sheet, (obj) => {
+        delete obj.cells[idx];
+      });
     } else {
       if (isFormula(value)) {
         value = this._graph.mapFunctionBindingToId(mapFormulaRefsToIndices(this._sheet, value));
       }
 
-      this._sheet.cells[idx] = { value };
+      Obj.update(this._sheet, (obj) => {
+        obj.cells[idx] = { value };
+      });
     }
   }
 

package/src/model/testing.ts

@@ -2,9 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import { addressToA1Notation } from '@dxos/compute';
+import { addressToA1Notation } from '@dxos/compute-hyperformula';
 
-import { Sheet } from '../types';
+import { Sheet } from '#types';
 
 // TODO(burdon): Create testing endpoint.
 // TODO(burdon): Move to react-ui-sheet.

package/src/model/useSheetModel.ts

@@ -4,10 +4,11 @@
 
 import { useEffect, useState } from 'react';
 
-import { type ComputeGraph } from '@dxos/compute';
+import { type ComputeGraph } from '@dxos/compute-hyperformula';
+
+import { type Sheet } from '#types';
 
 import { SheetModel } from '../model';
-import { type Sheet } from '../types';
 
 export type UseSheetModelOptions = {
   readonly?: boolean;

package/src/operations/drop-axis.ts

@@ -0,0 +1,26 @@
+//
+
+import * as Effect from 'effect/Effect';
+// Copyright 2025 DXOS.org
+//
+
+import { Operation } from '@dxos/compute';
+
+import { SheetOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof SheetOperation.DropAxis> = SheetOperation.DropAxis.pipe(
+  Operation.withHandler(({ model, axis, axisIndex }) =>
+    Effect.sync(() => {
+      const undoData = model[axis === 'col' ? 'dropColumn' : 'dropRow'](axisIndex);
+      return {
+        axis: undoData.axis,
+        axisIndex: undoData.axisIndex,
+        index: undoData.index,
+        axisMeta: undoData.axisMeta,
+        values: undoData.values,
+      };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/compute';
+
+export const SheetOperationHandlerSet = OperationHandlerSet.lazy(
+  () => import('./drop-axis'),
+  () => import('./insert-axis'),
+  () => import('./restore-axis'),
+  () => import('./scroll-to-anchor'),
+);

package/src/operations/insert-axis.ts

@@ -0,0 +1,19 @@
+//
+
+import * as Effect from 'effect/Effect';
+// Copyright 2025 DXOS.org
+//
+
+import { Operation } from '@dxos/compute';
+
+import { SheetOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof SheetOperation.InsertAxis> = SheetOperation.InsertAxis.pipe(
+  Operation.withHandler(({ model, axis, index, count }) =>
+    Effect.sync(() => {
+      model[axis === 'col' ? 'insertColumns' : 'insertRows'](index, count);
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/restore-axis.ts

@@ -0,0 +1,19 @@
+//
+
+import * as Effect from 'effect/Effect';
+// Copyright 2025 DXOS.org
+//
+
+import { Operation } from '@dxos/compute';
+
+import { SheetOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof SheetOperation.RestoreAxis> = SheetOperation.RestoreAxis.pipe(
+  Operation.withHandler(({ model, axis, ...restoreData }) =>
+    Effect.sync(() => {
+      model[axis === 'col' ? 'restoreColumn' : 'restoreRow'](restoreData);
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/scroll-to-anchor.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+
+import { parseThreadAnchorAsCellRange } from '../integrations/thread-ranges';
+import { SheetCapabilities, SheetOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof SheetOperation.ScrollToAnchor> = SheetOperation.ScrollToAnchor.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ subject, cursor, ref }) {
+      const gridInstances = yield* Capability.get(SheetCapabilities.GridInstances);
+      const entry = gridInstances.get(subject);
+      if (!entry) {
+        return;
+      }
+      entry.setActiveRefs(ref);
+      const range = parseThreadAnchorAsCellRange(cursor);
+      if (range) {
+        entry.grid.setFocus({ ...range.to, plane: 'grid' }, true);
+      }
+    }),
+  ),
+);
+
+export default handler;

package/src/playwright/playwright.config.ts

@@ -10,7 +10,7 @@ export default defineConfig({
   ...e2ePreset(import.meta.dirname),
   // TODO(wittjosiah): Avoid hard-coding ports.
   webServer: {
-    command: 'moon run storybook:serve-e2e -- --port=9005',
+    command: 'pnpm storybook dev --ci --quiet --port=9005 --config-dir=.storybook',
     port: 9005,
     reuseExistingServer: false,
   },

package/src/playwright/sheet.spec.ts

@@ -4,7 +4,7 @@
 
 import { type Page, expect, test } from '@playwright/test';
 
-import { faker } from '@dxos/random';
+import { random } from '@dxos/random';
 import { setupPage, storybookUrl } from '@dxos/test-utils/playwright';
 
 import { SheetManager } from './sheet-manager';
@@ -15,7 +15,8 @@ test.describe('plugin-sheet', () => {
 
   test.beforeEach(async ({ browser }) => {
     const setup = await setupPage(browser, {
-      url: storybookUrl('plugins-plugin-sheet-sheetcontainer--spec', 9005),
+      url: storybookUrl('plugins-plugin-sheet-containers-sheetarticle--spec', 9005),
+      viewportSize: { width: 1280, height: 720 },
     });
     page = setup.page;
     sheet = new SheetManager(page);
@@ -38,7 +39,7 @@ test.describe('plugin-sheet', () => {
     // Confirm editor displays
     await expect(sheet.cellEditor()).toBeVisible();
     // Type in a value and press enter
-    const testString = faker.string.uuid();
+    const testString = random.string.uuid();
     await sheet.setFocusedCellValue(testString, 'Enter');
     // Expect that value to now show in the grid
     await expect(sheet.cellByText(testString)).toBeVisible();

package/src/plugin.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const SheetPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
+export { SheetOperationHandlerSet } from './operations';

package/src/sanity.test.ts

@@ -5,7 +5,8 @@
 import { describe, expect, test } from 'vitest';
 
 import { Client } from '@dxos/client';
-import { Function } from '@dxos/functions';
+import { Operation } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
 
 // Part 2.
 // TODO(burdon): Cannot test outside of browser.
@@ -22,7 +23,7 @@ import { Function } from '@dxos/functions';
 describe('test', () => {
   test('test', async () => {
     const client = new Client();
-    client.addTypes([Function.Function]);
+    await client.addTypes([Operation.PersistentOperation]);
     await client.initialize();
     await client.halo.createIdentity();
 
@@ -33,7 +34,13 @@ describe('test', () => {
     //  - ERROR "process.nextTick is not a function"
     //  - ERROR "Identifier 'Buffer' has already been declared" if { nodeExternal: true }
     const space = await client.spaces.create();
-    const fn = space.db.add(Function.make({ name: 'test', version: '0.0.1', binding: 'HELLO' }));
+    const fn = space.db.add(
+      Obj.make(Operation.PersistentOperation, {
+        [Obj.Meta]: { key: 'com.example.function.test', version: '0.0.1' },
+        name: 'test',
+        binding: 'HELLO',
+      }),
+    );
     expect(fn).to.exist;
   });
 });

package/src/serializer.ts

@@ -3,10 +3,10 @@
 //
 
 import { Obj } from '@dxos/echo';
-import { type TypedObjectSerializer } from '@dxos/plugin-space/types';
-import { getObjectCore } from '@dxos/react-client/echo';
+import { getObjectCore } from '@dxos/echo-db';
+import { type TypedObjectSerializer } from '@dxos/plugin-space';
 
-import { Sheet } from './types';
+import { Sheet } from '#types';
 
 export const serializer: TypedObjectSerializer<Sheet.Sheet> = {
   serialize: async ({ object }): Promise<string> => {

package/src/testing/data.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import type { Sheet } from '../types';
+import type { Sheet } from '#types';
 
 export const createTestCells = (testSheetName = 'test'): Record<string, Sheet.CellValue> => ({
   B1: { value: 'Qty2' },

package/src/testing/testing.tsx

@@ -5,13 +5,13 @@
 import { type Decorator } from '@storybook/react';
 import React, { useState } from 'react';
 
-import { type ComputeGraph, type ComputeGraphOptions, ComputeGraphRegistry } from '@dxos/compute';
-import { createMockedComputeRuntimeProvider } from '@dxos/compute/testing';
+import { type ComputeGraph, type ComputeGraphOptions, ComputeGraphRegistry } from '@dxos/compute-hyperformula';
+import { createMockedComputeRuntimeProvider } from '@dxos/compute-hyperformula/testing';
 import { type Space } from '@dxos/react-client/echo';
 import { useAsyncState } from '@dxos/react-hooks';
 
-import { ComputeGraphContextProvider } from '../components';
-import { Sheet } from '../types';
+import { ComputeGraphContextProvider } from '#components';
+import { Sheet } from '#types';
 
 export const useTestSheet = (space?: Space, graph?: ComputeGraph, options?: Sheet.SheetProps) => {
   const [sheet] = useAsyncState(async () => {

package/src/translations.ts

@@ -4,48 +4,54 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
-import { Sheet } from './types';
+import { meta } from '#meta';
+import { Sheet } from '#types';
 
 export const translations = [
   {
     'en-US': {
       [Sheet.Sheet.typename]: {
-        'typename label': 'Sheet',
-        'typename label_zero': 'Sheets',
-        'typename label_one': 'Sheet',
-        'typename label_other': 'Sheets',
-        'object name placeholder': 'New sheet',
-        'rename object label': 'Rename sheet',
-        'delete object label': 'Delete sheet',
+        'typename.label': 'Sheet',
+        'typename.label_zero': 'Sheets',
+        'typename.label_one': 'Sheet',
+        'typename.label_other': 'Sheets',
+        'object-name.placeholder': 'New sheet',
+        'add-object.label': 'Add sheet',
+        'rename-object.label': 'Rename sheet',
+        'delete-object.label': 'Delete sheet',
+        'object-deleted.label': 'Sheet deleted',
       },
       [meta.id]: {
-        'plugin name': 'Sheets',
-        'cell placeholder': 'Cell value...',
-        'range key alignment label': 'Align',
-        'range key style label': 'Style',
-        'range value start label': 'Align left',
-        'range value center label': 'Align center',
-        'range value end label': 'Align right',
-        'range value softwrap label': 'Wrap text',
-        'range value highlight label': 'Highlight',
-        'toolbar action label': '{{value}}',
-        'selection overlaps existing comment label': 'Selected cell already has a comment',
-        'comment label': 'Add comment',
-        'comment ranges not supported label': 'Commenting on ranges is not yet supported',
-        'no cursor label': 'Select a cell to comment',
-        'open comment for sheet cell': 'View comments for cell',
-        'add col before label': 'Add column before',
-        'add col after label': 'Add column after',
-        'delete col label': 'Delete column',
-        'add row before label': 'Add row before',
-        'add row after label': 'Add row after',
-        'delete row label': 'Delete row',
-        'range list heading': 'Ranges',
-        'no ranges message': 'No ranges',
-        'range title': '{{position}} — {{value}}',
-        'col dropped label': 'Deleted a column',
-        'row dropped label': 'Deleted a row',
+        'plugin.name': 'Sheets',
+        'cell.placeholder': 'Cell value...',
+
+        'range-key.alignment.label': 'Align',
+        'range-key.style.label': 'Style',
+
+        'range-value.start.label': 'Align left',
+        'range-value.center.label': 'Align center',
+        'range-value.end.label': 'Align right',
+        'range-value.softwrap.label': 'Wrap text',
+        'range-value.highlight.label': 'Highlight',
+
+        'toolbar-action.label': '{{value}}',
+        'selection-overlaps-existing-comment.label': 'Selected cell already has a comment',
+        'comment.label': 'Add comment',
+        'comment-ranges-not-supported.label': 'Commenting on ranges is not yet supported',
+        'no-cursor.label': 'Select a cell to comment',
+        'add-col-before.label': 'Add column before',
+        'add-col-after.label': 'Add column after',
+        'delete-col.label': 'Delete column',
+        'add-row-before.label': 'Add row before',
+        'add-row-after.label': 'Add row after',
+        'delete-row.label': 'Delete row',
+        'range-list.heading': 'Ranges',
+        'no-ranges.message': 'No ranges',
+        'range.title': '{{position}} — {{value}}',
+        'col-dropped.label': 'Deleted a column',
+        'row-dropped.label': 'Deleted a row',
+        'align.label': 'Text align',
+        'axis-dropped.label': 'Drop axis', // TODO(burdon): What does this mean?
       },
     },
   },