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

package/src/operations/index.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/operation';
+
+export * as SheetOperation from './definitions';
+
+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 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/operation';
+
+import { InsertAxis } from './definitions';
+
+const handler: Operation.WithHandler<typeof InsertAxis> = 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 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/operation';
+
+import { RestoreAxis } from './definitions';
+
+const handler: Operation.WithHandler<typeof RestoreAxis> = 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,31 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/operation';
+
+import { parseThreadAnchorAsCellRange } from '../integrations/thread-ranges';
+import { SheetCapabilities } from '../types';
+import { ScrollToAnchor } from './definitions';
+
+const handler: Operation.WithHandler<typeof ScrollToAnchor> = 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

@@ -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);

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 { Obj } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
 
 // 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,9 @@ 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, { name: 'test', version: '0.0.1', binding: 'HELLO' }),
+    );
     expect(fn).to.exist;
   });
 });

package/src/serializer.ts

@@ -3,8 +3,8 @@
 //
 
 import { Obj } from '@dxos/echo';
+import { getObjectCore } from '@dxos/echo-db';
 import { type TypedObjectSerializer } from '@dxos/plugin-space/types';
-import { getObjectCore } from '@dxos/react-client/echo';
 
 import { Sheet } from './types';
 

package/src/translations.ts

@@ -16,8 +16,10 @@ export const translations = [
         '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',

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 { 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.change to satisfy change context requirements.
+  Obj.change(sheet, (obj) => {
+    initialize(obj, size);
+
+    if (cells) {
+      Object.entries(cells).forEach(([key, { value }]) => {
+        const idx = addressToIndex(obj, addressFromA1Notation(key));
+        if (isFormula(value)) {
+          value = mapFormulaRefsToIndices(obj, value);
+        }
+
+        obj.cells[idx] = { value };
+      });
+    }
+  });
 
   return sheet;
 };

package/src/types/capabilities.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+import { type ComputeGraphRegistry } from '@dxos/compute';
+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 namespace SheetCapabilities {
+  export const ComputeGraphRegistry = Capability.make<ComputeGraphRegistry>(
+    `${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/index.ts

@@ -2,6 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
+export * from './capabilities';
 export * as Sheet from './Sheet';
 export * from './sheet-range-types';
 export * from './types';

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

@@ -11,6 +11,7 @@ import {
   isFormula,
 } from '@dxos/compute';
 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) {