@dxos/plugin-sheet 0.8.4-main.72ec0f3 → 0.8.4-main.765dc60934

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-sheetcontainer--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?
       },
     },
   },

package/src/types/Sheet.ts

@@ -2,11 +2,13 @@
 // Copyright 2023 DXOS.org
 //
 
+// @import-as-namespace
+
 import * as Schema from 'effect/Schema';
 
-import { addressFromA1Notation, isFormula } from '@dxos/compute';
-import { Obj, Type } from '@dxos/echo';
-import { FormAnnotation } from '@dxos/echo/internal';
+import { addressFromA1Notation, isFormula } from '@dxos/compute-hyperformula';
+import { Annotation, Obj, Type } from '@dxos/echo';
+import { FormInputAnnotation } from '@dxos/echo/internal';
 
 import { addressToIndex, initialize, mapFormulaRefsToIndices } from './util';
 
@@ -44,36 +46,31 @@ export const Sheet = Schema.Struct({
   name: Schema.optional(Schema.String),
 
   // Sparse map of cells referenced by index.
-  cells: Schema.Record({ key: Schema.String, value: Schema.mutable(CellValue) }).pipe(
-    Schema.mutable,
-    FormAnnotation.set(false),
-  ),
+  cells: Schema.Record({ key: Schema.String, value: CellValue }).pipe(FormInputAnnotation.set(false)),
 
   // Ordered row indices.
-  rows: Schema.Array(Schema.String).pipe(Schema.mutable, FormAnnotation.set(false)),
+  rows: Schema.Array(Schema.String).pipe(FormInputAnnotation.set(false)),
 
   // Ordered column indices.
-  columns: Schema.Array(Schema.String).pipe(Schema.mutable, FormAnnotation.set(false)),
+  columns: Schema.Array(Schema.String).pipe(FormInputAnnotation.set(false)),
 
   // Row metadata referenced by index.
-  rowMeta: Schema.Record({ key: Schema.String, value: Schema.mutable(RowColumnMeta) }).pipe(
-    Schema.mutable,
-    FormAnnotation.set(false),
-  ),
+  rowMeta: Schema.Record({ key: Schema.String, value: RowColumnMeta }).pipe(FormInputAnnotation.set(false)),
 
   // Column metadata referenced by index.
-  columnMeta: Schema.Record({ key: Schema.String, value: Schema.mutable(RowColumnMeta) }).pipe(
-    Schema.mutable,
-    FormAnnotation.set(false),
-  ),
+  columnMeta: Schema.Record({ key: Schema.String, value: RowColumnMeta }).pipe(FormInputAnnotation.set(false)),
 
   // Cell formatting referenced by indexed range.
-  ranges: Schema.Array(Range).pipe(Schema.mutable, FormAnnotation.set(false)),
+  ranges: Schema.Array(Range).pipe(FormInputAnnotation.set(false)),
 }).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Sheet',
+  Type.object({
+    typename: 'org.dxos.type.sheet',
     version: '0.1.0',
   }),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--grid-nine--regular',
+    hue: 'indigo',
+  }),
 );
 
 export interface Sheet extends Schema.Schema.Type<typeof Sheet> {}
@@ -86,18 +83,21 @@ export type SheetProps = {
 export const make = ({ name, cells = {}, ...size }: SheetProps = {}) => {
   const sheet = Obj.make(Sheet, { name, cells: {}, rows: [], columns: [], rowMeta: {}, columnMeta: {}, ranges: [] });
 
-  initialize(sheet, size);
-
-  if (cells) {
-    Object.entries(cells).forEach(([key, { value }]) => {
-      const idx = addressToIndex(sheet, addressFromA1Notation(key));
-      if (isFormula(value)) {
-        value = mapFormulaRefsToIndices(sheet, value);
-      }
-
-      sheet.cells[idx] = { value };
-    });
-  }
+  // Initialize and set cells within Obj.update to satisfy change context requirements.
+  Obj.update(sheet, (sheet) => {
+    initialize(sheet, size);
+
+    if (cells) {
+      Object.entries(cells).forEach(([key, { value }]) => {
+        const idx = addressToIndex(sheet, addressFromA1Notation(key));
+        if (isFormula(value)) {
+          value = mapFormulaRefsToIndices(sheet, value);
+        }
+
+        sheet.cells[idx] = { value };
+      });
+    }
+  });
 
   return sheet;
 };

package/src/types/SheetCapabilities.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { Capability } from '@dxos/app-framework';
+import { type ComputeGraphRegistry as ComputeGraphRegistryType } from '@dxos/compute-hyperformula';
+import { type DxGridElement, type GridContentProps } from '@dxos/react-ui-grid';
+
+import { meta } from '#meta';
+
+export type GridEntry = { grid: DxGridElement; setActiveRefs: (refs: GridContentProps['activeRefs']) => void };
+
+export type GridRegistry = {
+  register: (attendableId: string, grid: DxGridElement, setActiveRefs: GridEntry['setActiveRefs']) => void;
+  unregister: (attendableId: string) => void;
+  get: (attendableId: string) => GridEntry | undefined;
+};
+
+export const ComputeGraphRegistry = Capability.make<ComputeGraphRegistryType>(
+  `${meta.id}.capability.compute-graph-registry`,
+);
+
+/** Registry of active grid instances keyed by attendable ID. */
+export const GridInstances = Capability.make<GridRegistry>(`${meta.id}.capability.grid-instances`);

package/src/types/SheetOperation.ts

@@ -0,0 +1,75 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+
+import { meta } from '#meta';
+
+const SHEET_OPERATION = `${meta.id}.operation`;
+
+// TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
+const Axis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
+
+export const InsertAxis = Operation.make({
+  meta: { key: `${SHEET_OPERATION}.axis-insert`, name: 'Insert Axis' },
+  input: Schema.Struct({
+    model: Schema.Any,
+    axis: Axis,
+    index: Schema.Number,
+    count: Schema.optional(Schema.Number),
+  }),
+  output: Schema.Void,
+});
+
+export const DropAxisOutput = Schema.Struct({
+  axis: Axis.annotations({ description: 'The axis type (row or col).' }),
+  axisIndex: Schema.String.annotations({ description: 'The dropped axis index.' }),
+  index: Schema.Number.annotations({ description: 'The position the axis was at.' }),
+  axisMeta: Schema.Any.annotations({ description: 'The row/column metadata.' }),
+  values: Schema.Array(Schema.Any).annotations({ description: 'The cell values that were dropped.' }),
+});
+
+export type DropAxisOutput = Schema.Schema.Type<typeof DropAxisOutput>;
+
+export const DropAxis = Operation.make({
+  meta: { key: `${SHEET_OPERATION}.axis-drop`, name: 'Drop Axis' },
+  input: Schema.Struct({
+    model: Schema.Any,
+    axis: Axis,
+    axisIndex: Schema.String,
+  }),
+  output: DropAxisOutput,
+});
+
+export const ScrollToAnchor = Operation.make({
+  meta: { key: `${SHEET_OPERATION}.scroll-to-anchor`, name: 'Scroll To Anchor' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    subject: Schema.String.annotations({ description: 'Attendable ID of the sheet.' }),
+    cursor: Schema.String.annotations({ description: 'Cell range coordinates.' }),
+    ref: Schema.optional(Schema.Any.annotations({ description: 'Active refs for highlighting.' })),
+  }),
+  output: Schema.Void,
+});
+
+/**
+ * Restore a dropped axis (inverse of DropAxis).
+ */
+export const RestoreAxis = Operation.make({
+  meta: { key: `${SHEET_OPERATION}.restore-axis`, name: 'Restore Axis' },
+  input: Schema.Struct({
+    model: Schema.Any.annotations({ description: 'The sheet model.' }),
+    axis: Axis.annotations({ description: 'The axis type (row or col).' }),
+    axisIndex: Schema.String.annotations({ description: 'The axis index to restore.' }),
+    index: Schema.Number.annotations({ description: 'The position to restore at.' }),
+    axisMeta: Schema.Any.annotations({ description: 'The row/column metadata.' }),
+    values: Schema.Array(Schema.Any).annotations({ description: 'The cell values to restore.' }),
+  }),
+  output: Schema.Void,
+});

package/src/types/index.ts

@@ -2,7 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-export * as Sheet from './Sheet';
 export * from './sheet-range-types';
 export * from './types';
 export * from './util';
+
+export * as Sheet from './Sheet';
+export * as SheetCapabilities from './SheetCapabilities';
+export * as SheetOperation from './SheetOperation';

package/src/types/sheet-range-types.ts

@@ -34,14 +34,14 @@ export const cellClassNameForRange = ({ key, value }: Sheet.Sheet['ranges'][numb
       }
 
     case commentKey:
-      return 'bg-gridComment';
+      return 'bg-grid-comment';
 
     case styleKey:
       switch (value) {
         case 'highlight':
-          return '!bg-gridHighlight';
+          return 'bg-grid-highlight!';
         case 'softwrap':
-          return '!whitespace-normal';
+          return 'whitespace-normal!';
         default:
           return undefined;
       }

package/src/types/types.ts

@@ -4,39 +4,14 @@
 
 import * as Schema from 'effect/Schema';
 
-import { meta } from '../meta';
-import { SheetModel } from '../model';
-
 import * as Sheet from './Sheet';
 
-export namespace SheetAction {
-  const SHEET_ACTION = `${meta.id}/action`;
-
-  export class Create extends Schema.TaggedClass<Create>()(`${SHEET_ACTION}/create`, {
-    input: Schema.Struct({
-      name: Schema.optional(Schema.String),
-    }),
-    output: Schema.Struct({
-      object: Sheet.Sheet,
-    }),
-  }) {}
-
-  // TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
-  const Axis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
-
-  export class InsertAxis extends Schema.TaggedClass<InsertAxis>()(`${SHEET_ACTION}/axis-insert`, {
-    input: Schema.Struct({
-      // TODO(wittjosiah): Schema.instanceOf(SheetModel) throws when running tests.
-      model: Schema.Any.pipe(Schema.filter((model) => model instanceof SheetModel)) as Schema.Schema<SheetModel>,
-      axis: Axis,
-      index: Schema.Number,
-      count: Schema.optional(Schema.Number),
-    }),
-    output: Schema.Void,
-  }) {}
+// TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
+const ActionAxis = Schema.Union(Schema.Literal('row'), Schema.Literal('col'));
 
+export namespace SheetAction {
   export const RestoreAxis = Schema.Struct({
-    axis: Axis,
+    axis: ActionAxis,
     axisIndex: Schema.String,
     index: Schema.Number,
     axisMeta: Sheet.RowColumnMeta,
@@ -44,15 +19,4 @@ export namespace SheetAction {
   });
 
   export type RestoreAxis = Schema.Schema.Type<typeof RestoreAxis>;
-
-  export class DropAxis extends Schema.TaggedClass<DropAxis>()(`${SHEET_ACTION}/axis-drop`, {
-    input: Schema.Struct({
-      // TODO(wittjosiah): Schema.instanceOf(SheetModel) throws when running tests.
-      model: Schema.Any.pipe(Schema.filter((model) => model instanceof SheetModel)) as Schema.Schema<SheetModel>,
-      axis: Axis,
-      axisIndex: Schema.String,
-      deletionData: Schema.optional(RestoreAxis),
-    }),
-    output: Schema.Void,
-  }) {}
 }

package/src/types/util.ts

@@ -9,8 +9,9 @@ import {
   addressFromA1Notation,
   addressToA1Notation,
   isFormula,
-} from '@dxos/compute';
+} from '@dxos/compute-hyperformula';
 import { randomBytes } from '@dxos/crypto';
+import { type Obj } from '@dxos/echo';
 import { invariant } from '@dxos/invariant';
 
 import { type Sheet } from '../types';
@@ -55,7 +56,7 @@ export const insertIndices = (indices: string[], i: number, n: number, max: numb
 };
 
 export const initialize = (
-  sheet: Sheet.Sheet,
+  sheet: Obj.Mutable<Sheet.Sheet>,
   { rows = DEFAULT_ROWS, columns = DEFAULT_COLS }: Partial<Sheet.SheetSize> = {},
 ) => {
   if (!sheet.rows.length) {