@dxos/plugin-sheet 0.8.4-main.3eb6e50203 → 0.8.4-main.3fbcb4aa9b

package/src/translations.ts

@@ -4,49 +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',
-        'object deleted label': 'Sheet deleted',
+        '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,10 +2,12 @@
 // 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 { 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';
@@ -62,9 +64,13 @@ export const Sheet = Schema.Struct({
   ranges: Schema.Array(Range).pipe(FormInputAnnotation.set(false)),
 }).pipe(
   Type.object({
-    typename: 'dxos.org/type/Sheet',
+    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> {}
@@ -77,18 +83,18 @@ export type SheetProps = {
 export const make = ({ name, cells = {}, ...size }: SheetProps = {}) => {
   const sheet = Obj.make(Sheet, { name, cells: {}, rows: [], columns: [], rowMeta: {}, columnMeta: {}, ranges: [] });
 
-  // Initialize and set cells within Obj.change to satisfy change context requirements.
-  Obj.change(sheet, (s) => {
-    initialize(s, size);
+  // 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(s, addressFromA1Notation(key));
+        const idx = addressToIndex(sheet, addressFromA1Notation(key));
         if (isFormula(value)) {
-          value = mapFormulaRefsToIndices(s, value);
+          value = mapFormulaRefsToIndices(sheet, value);
         }
 
-        s.cells[idx] = { value };
+        sheet.cells[idx] = { value };
       });
     }
   });

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,8 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './capabilities';
-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,13 +4,6 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Capability } from '@dxos/app-framework';
-import { Operation } from '@dxos/operation';
-import { SpaceSchema } from '@dxos/react-client/echo';
-import { Collection } from '@dxos/schema';
-
-import { meta } from '../meta';
-
 import * as Sheet from './Sheet';
 
 // TODO(wittjosiah): Factor out. This is `DxGridAxis` from `@dxos/react-ui-grid`.
@@ -27,76 +20,3 @@ export namespace SheetAction {
 
   export type RestoreAxis = Schema.Schema.Type<typeof RestoreAxis>;
 }
-
-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 namespace SheetOperation {
-  export const OnCreateSpace = Operation.make({
-    meta: { key: `${SHEET_OPERATION}/on-create-space`, name: 'On Create Space' },
-    services: [Capability.Service],
-    schema: {
-      input: Schema.Struct({
-        space: SpaceSchema,
-        rootCollection: Collection.Collection,
-        isDefault: Schema.optional(Schema.Boolean),
-      }),
-      output: Schema.Void,
-    },
-  });
-
-  export const InsertAxis = Operation.make({
-    meta: { key: `${SHEET_OPERATION}/axis-insert`, name: 'Insert Axis' },
-    schema: {
-      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' },
-    schema: {
-      input: Schema.Struct({
-        model: Schema.Any,
-        axis: Axis,
-        axisIndex: Schema.String,
-      }),
-      output: DropAxisOutput,
-    },
-  });
-
-  /**
-   * Restore a dropped axis (inverse of DropAxis).
-   */
-  export const RestoreAxis = Operation.make({
-    meta: { key: `${SHEET_OPERATION}/restore-axis`, name: 'Restore Axis' },
-    schema: {
-      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/util.ts

@@ -9,7 +9,7 @@ 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';